Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up persist.py #1601

Open
trevorbaca opened this issue Jan 3, 2025 · 0 comments
Open

Clean up persist.py #1601

trevorbaca opened this issue Jan 3, 2025 · 0 comments
Assignees
Labels
Milestone

Comments

@trevorbaca
Copy link
Member

For LilyPond file persistence:

OLD: abjad.persist.ly(..., tags=False)
NEW: abjad.persist.ly(..., keep_tags=False)
OLD: abjad.persist.ly(..., **keywords)
NEW: abjad.persist.ly(..., **illustrate_keywords)
OLD: abjad.persist.ly() returned pair of ly_file_path and Abjad format time in seconds
NEW: abjad.persist.ly() returns only Abjad format time in seconds

For MIDI persistence:

OLD: abjad.persist.as_midi(..., flags="")
NEW: abjad.persist.as_midi(..., lilypond_flags="")
OLD: abjad.persist.as_midi(..., **keywords)
NEW: abjad.persist.as_midi(..., **illustrate_keywords)
OLD: abjad.persist.as_midi() returned 4-tuple:
    * pdf_file_path to which PDF was written
    * Abjad format time in seconds
    * LilyPond render time in seconds
    * abjad.io.run_lilypond() exit code
NEW: abjad.persist.as_midi() returns triple:
    * Abjad format time in seconds
    * LilyPond render time in seconds
    * abjad.io.run_lilypond() exit code

For PDF persistence:

OLD: abjad.persist.as_pdf(..., flags="")
NEW: abjad.persist.as_pdf(..., lilypond_flags="")
OLD: abjad.persist.pdf(..., tags=False)
NEW: abjad.persist.pdf(..., keep_tags=False)
OLD: abjad.persist.pdf(argument, "/path/to/file") wrote /path/to/file.pdf with (implicitly added) .pdf extension
NEW: abjad.persist.pdf(argument, "/path/to/file") raises an exception; use "/path/to/file.pdf" instead
OLD: abjad.persist.pdf(..., **keywords)
NEW: abjad.persist.pdf(..., **illustrate_keywords)
OLD: abjad.persist.as_pdf() returned 4-tuple:
    * pdf_file_path to which PDF was written
    * Abjad format time in seconds
    * LilyPond render time in seconds
    * abjad.io.run_lilypond() exit code
NEW: abjad.persist.as_pdf() returns triple:
    * Abjad format time in seconds
    * LilyPond render time in seconds
    * abjad.io.run_lilypond() exit code

For PNG persistence:

OLD: abjad.persist.as_png(..., flags="")
NEW: abjad.persist.as_png(..., lilypond_flags="")
OLD: abjad.persist.png(..., tags=False)
NEW: abjad.persist.png(..., keep_tags=False)
OLD: abjad.persist.png(..., **keywords)
NEW: abjad.persist.png(..., **illustrate_keywords)

In other modules:

OLD: abjad.lilypond(..., site_comments=False)
NEW: abjad.lilypond(..., keep_site_comments=False)
OLD: abjad.lilypond(..., tags=False)
NEW: abjad.lilypond(..., keep_tags=False)
@trevorbaca trevorbaca added this to the 3.20 milestone Jan 3, 2025
@trevorbaca trevorbaca self-assigned this Jan 3, 2025
@trevorbaca trevorbaca modified the milestones: 3.20, 3.21 Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant