Thanks, that helps me understand and I appreciate the welcome. I can understand that it's not straightforward. I might circle back around and help at some point, especially if I end up using it more heavily.
I don't come from a Java background - jsdoc and phpdoc are the main ones outside of the Python world that I've used in the past few years, and I haven't pushed them very far the way that a public project with a lot of users might. On Monday, September 3, 2018 at 8:46:34 PM UTC-7, Ben Creasy wrote: > > Thank you for the amazing tool! I've been messing around with SQLAlchemy a > little bit lately, mostly in the context of projects such as > https://github.com/miLibris/flask-rest-jsonapi and > https://github.com/jfinkels/flask-restless. Apologies for my ignorance. > > I've noticed that there are a whole lot of properties on the > InstrumentedAttribute of a mapped class instance (shown below). It's a bit > overwhelming, but since the docs are so thorough I figured I'd find > documentation on all the public properties, but for a few, I couldn't find > documentation, including: dispatch, expression, and impl. A search for > dispatch (for example) didn't turn up the precise documentation that I > might expect from for a public property ( > http://docs.sqlalchemy.org/en/latest/search.html?q=dispatch&check_keywords=yes&area=default > ). > > I found documentation for some of them over at > http://docs.sqlalchemy.org/en/latest/orm/internals.html#sqlalchemy.orm.attributes.InstrumentedAttribute > and > its base classes In my screenshot, I count 20 public properties, altho 8 of > them are from the InspectionAttr ( > http://docs.sqlalchemy.org/en/latest/orm/internals.html#sqlalchemy.orm.base.InspectionAttr). > > The QueryableAttribute > <http://docs.sqlalchemy.org/en/latest/orm/internals.html#sqlalchemy.orm.attributes.QueryableAttribute> > and > PropsComparator > <http://docs.sqlalchemy.org/en/latest/orm/internals.html#sqlalchemy.orm.interfaces.PropComparator> > > seem similar as both provide the adapter. The remaining 11 are: class_, > comparator, dispatch, expression, impl, info, key, parent, prop, property, > and timetuple. > > info is documented for MapperProperty, but MapperProperty is not one of > the bases for QueryableAttribute - is it mixed in or is this a convenience > shortcut on QueryableAttribute perhaps? > > Also: > (1) property is mentioned narratively at the top of the QueryableAttribute > not called out the way other properties are, and has this duplicate "prop" > (why?). > (2) adapt_to_property is shown as public in the docs but in my screenshot > seems to be prefixed by an underscore suggesting internal use. > > If a PR updating the docs is welcome, let me know and I might take a stab > (altho I'm a newb at this, so don't expect much). > > > [image: Screen Shot 2018-09-03 at 7.58.23 PM.png] > -- SQLAlchemy - The Python SQL Toolkit and Object Relational Mapper http://www.sqlalchemy.org/ To post example code, please provide an MCVE: Minimal, Complete, and Verifiable Example. See http://stackoverflow.com/help/mcve for a full description. --- You received this message because you are subscribed to the Google Groups "sqlalchemy" group. To unsubscribe from this group and stop receiving emails from it, send an email to sqlalchemy+unsubscr...@googlegroups.com. To post to this group, send email to sqlalchemy@googlegroups.com. Visit this group at https://groups.google.com/group/sqlalchemy. For more options, visit https://groups.google.com/d/optout.
