Hi all, In the last days I have built a documentation of the current state of Options. Based on feedback and prototyping I have thought of a potential interface for _meta that can solve the issues currently present, such as redundancy (in code and in caching systems). The interface has also been thought to be maintainable and is a base that can be used to create custom meta stores. Obviously this is far from perfect, It will need many iterations and maybe it is too complex. I would really love to gain as much feedback as possible so it can be discussed with Russell and the community on Monday.
The documentation of _meta can be found here: https://github.com/PirosB3/django/blob/meta_documentation/docs/ref/models/meta.txt I will be refining the document in the next days, I will also be publishing the docs on a webserver and will be linking a URL soon. My proposal has been published here: https://gist.github.com/PirosB3/371704ed40ed093d5a82 In the next days I will be iterating over the feedback gained, and based on one very interesting suggestion on IRC, I will try to see how my API syntax looks in modelforms.py. As said previously, and feedback is greatly appreciated. Hi from Pycon IT! Daniel Pyrathon On Tuesday, May 20, 2014 3:25:45 PM UTC+2, Josh Smeaton wrote: > > Best of luck! > > On Tuesday, 20 May 2014 03:56:06 UTC+10, Daniel Pyrathon wrote: >> >> Hi All, >> >> Today I will be starting my weekly updates on my SoC project: refactoring >> Meta to a stable API. For anyone who missed out, you will be able to view >> it here: >> https://docs.google.com/document/d/1yp2_skqkxyrc0egdRv6ofnRGCI9nmvxDFBkCXgy0Jwo/edit >> >> This week is the first official week of SoC. Me and my mentor (Russell) >> are initially approaching the work in the following way: >> >> - *Document the existing Meta API* >> For each endpoint, document the following: >> - Input parameters and return type >> - Caching pattern used >> - Where it's called from (internally and externally to Meta) >> - Why is it being called >> - When is it being called >> >> - *Propose an initial refactor plan* >> Once the documentation has been done, I should have a better idea of >> the current implementation. This will allow me to mock a proposed >> implementation that will be reviewed at my next update call, on Monday. >> >> My next update will be posted on Friday, just to make sure the community >> is informed of my progress. For any major updates that require community >> approval, I will be creating separate threads. >> My name on the internet is pirosb3, so if you want to have a chat about >> my progress feel free to contact me! The branch I am currently working on >> is https://github.com/PirosB3/django/tree/meta_documentation >> >> Regards, >> Daniel Pyrathon >> > On Tuesday, May 20, 2014 3:25:45 PM UTC+2, Josh Smeaton wrote: > > Best of luck! > > On Tuesday, 20 May 2014 03:56:06 UTC+10, Daniel Pyrathon wrote: >> >> Hi All, >> >> Today I will be starting my weekly updates on my SoC project: refactoring >> Meta to a stable API. For anyone who missed out, you will be able to view >> it here: >> https://docs.google.com/document/d/1yp2_skqkxyrc0egdRv6ofnRGCI9nmvxDFBkCXgy0Jwo/edit >> >> This week is the first official week of SoC. Me and my mentor (Russell) >> are initially approaching the work in the following way: >> >> - *Document the existing Meta API* >> For each endpoint, document the following: >> - Input parameters and return type >> - Caching pattern used >> - Where it's called from (internally and externally to Meta) >> - Why is it being called >> - When is it being called >> >> - *Propose an initial refactor plan* >> Once the documentation has been done, I should have a better idea of >> the current implementation. This will allow me to mock a proposed >> implementation that will be reviewed at my next update call, on Monday. >> >> My next update will be posted on Friday, just to make sure the community >> is informed of my progress. For any major updates that require community >> approval, I will be creating separate threads. >> My name on the internet is pirosb3, so if you want to have a chat about >> my progress feel free to contact me! The branch I am currently working on >> is https://github.com/PirosB3/django/tree/meta_documentation >> >> Regards, >> Daniel Pyrathon >> > -- You received this message because you are subscribed to the Google Groups "Django developers" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/django-developers. To view this discussion on the web visit https://groups.google.com/d/msgid/django-developers/8e669fa9-65b8-4a7a-bee5-22d9b4db9f36%40googlegroups.com. For more options, visit https://groups.google.com/d/optout.
