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

Breaking API updates #9

Open
9 tasks
MoralCode opened this issue Jul 4, 2021 · 0 comments
Open
9 tasks

Breaking API updates #9

MoralCode opened this issue Jul 4, 2021 · 0 comments
Labels
discussion issues or PR's created for future planning or soliciting feedback and discussion
Milestone

Comments

@MoralCode
Copy link
Owner

MoralCode commented Jul 4, 2021

This is an issue for compiling a list of breaking API changes that would be nice to have, but arent really worth doing on their own. The plan is to save them all up and apply them all at once whenever version 1.0 is considered ready.

The list:

  • rename the model classes to have more descriptive names
  • give all the model classes a consistent API (and maybe create some superclass or interface for this?)
    • make the parse() methods on each class generic (using fields and methods defined by the model classes) and pull it up into a superclass for deduplication
  • convert the constructor of the Days class to a class method from_range and make a simpler constructor (this will require some pretty major refactoring)
  • allow the output format to be customized #3
  • rename Times to TimeRange and create a class Times that can store multiple TimeRange's similar to Days (see support several opening and closing times for a single day #5)
  • make is_24_hr() and is_12_hour() in Time consistent
  • create a common system for specifying assumptions to make when the information is not available (for AM/PM, and century/year)
  • make all the from_parse_results methods consistent with regard to if they are processing a clean dictionary or a pyparsing.ParseResult object and possibly rename them to from_parse_result_dict
@MoralCode MoralCode added the discussion issues or PR's created for future planning or soliciting feedback and discussion label Jul 4, 2021
@MoralCode MoralCode added this to the Version 1.0 milestone Jul 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion issues or PR's created for future planning or soliciting feedback and discussion
Projects
None yet
Development

No branches or pull requests

1 participant