root / elixir / trunk / CHANGES @ 426

Revision 426, 22.3 kB (checked in by ged, 6 years ago)

- Fixed filter argument on OneToMany relationship leaking the filter to the

unfiltered relationship. Doh!!!

- added preliminary code for filter on ManyToMany (but see ticket #68 comment)
- renamed M2M.secondary_table to M2M.table

3Please see for detailed
4upgrade notes.
6New features:
7- Added a new statement 'using_options_defaults' which can be used
8  on a custom base class to set default values for the options of all its
9  subclasses. For example, this makes it possible to have all classes
10  inheriting from your custom base class use some custom options without
11  having to set it indivudually on each entity,
12  nor modify options.options_defaults.
13- The local_colname and remote_colname arguments on ManyToMany relationships
14  can now also be used to set custom names for the ManyToMany table columns.
15  This effectively replace the column_format on ManyToMany relationships which
16  is now deprecated. Change based on a patch from Diez B. Roggisch.
17- Added (or rather fixed and documented) a "table" argument on ManyToMany
18  relationships to allow using a manually-defined Table (closes #44).
19- Added a "schema" argument on ManyToMany relationship to be able to create the
20  ManyToMany table in a custom schema and not necessarily the same schema as
21  the table of the "source" entity (patch from Diez B. Roggisch).
22- Added a new "target_column" argument on ManyToOne relationships (ticket #26).
24- Added new column_names argument to the acts_as_versioned extension, allowing
25  to specify custom column names (inspired by a patch by Alex Bodnaru).
26- Added two new extensions (contributed by Alex Bodnaru)
27  - "perform_ddl" allows to execute one or several DDL statements upon table
28    creation.
29  - "preload_data" allows to insert data into the entity table just after it
30    has been created.
33- Moved class instrumentation to a separate function: instrument_class
34- Moved all methods of the "Entity" base class, to the "EntityBase" class, so
35  that people who want to provide their own base class but don't want to loose
36  all the methods provided by "Entity" can simply inherit from EntityBase
37  instead of copy-pasting the code for all its methods.
38- Renamed remote_side and local_side ManyToMany arguments to remote_colname and
39  local_colname respectively to not collide with the remote_side argument
40  provided by SA (it doesn't make much sense on ManyToMany relationships but
41  still).
42- Delete Elixir properties in the setup phase rather than as soon as they are
43  attached to their class. It makes it possible to access them or refer to them
44  after the class is defined (but before setup).
46Bug fixes:
47- default EntityCollection raise an exception instead of returning None when
48  trying to resolve an inexisting Entity from outside of another entity (for
49  example through EntityCollection.__getattr__
50- Changed slightly the algorithm to generate the name of the table for
51  bidirectional self-referential ManyToMany relationships so that it doesn't
52  depend on the order of declaration of each side (closes #19). If you are
53  upgrading an application with existing data from an earlier version of
54  Elixir, you are STRONGLY ADVISED to read the upgrade notes!
55  =================
57  =================
58  For now it is even worse: the table works but the relationship's meaning is
59  reversed. Will be fixed before 0.7 ships (see ticket #69).
60  =================
61- Fixed the case where you specify both "primaryjoin" and "colname" arguments
62  (useless in this case, but harmless) on a ManyToOne relationship of an
63  autoloaded entity.
64- Fixed bug which broke the "identity" (Entity) option
65- Fixed documentation about local_side and remote_side arguments being
66  required if the entity containing the relationship is autoloaded, when it is
67  only required if the relationship is self-referencial, and primaryjoin or
68  secondaryjoin as not been specified manually.
69- Added missing documentation for the "filter" argument on OneToMany
70  relationships
71- Fixed the act_as_list extension's move_to_bottom method to work on MySQL
72  (closes #34).
73- Fixed event methods not being called when they are defined on a parent class.
74  (introduced in r262).
75- Added workaround for an odd mod_python behavior (class.__module__ returns a
76  weird name which is not in sys.modules).
77- Fixed filter argument on OneToMany relationship leaking the filter to the
78  unfiltered relationship.
800.6.1 - 2008-08-18
82New features:
83- Allow ManyToOne relationships to use manually created fields as their
84  "supporting column". This means that the columns can be customized without
85  resorting to using the ugly "column_kwargs" (patch from Jason R. Coombs,
86  closes #39).
87- Extra args and kwargs to Synonym and ColumnProperty are forwarded to their
88  underlying constructs. This allows for example deferred ColumnProperties.
89- Added a more helpful assertion message when inverse relationship types don't
90  match.
93- Removed support for the deprecated "with_fields" syntax
94- Entity.__init__ calls Entity.set instead of duplicating its functionality
96Bug fixes:
97- Fixed the "Target resolves to several entities" exception message to actually
98  include the target name.
99- Renamed the on_reconstitute method decorator to reconstructor, to track the
100  corresponding change in SA's trunk.
1020.6.0 - 2008-07-18
104Please see for detailed
105upgrade notes.
107New features:
108- Fields in a custom base class are added to all their children.
109- Added two new methods on the base entity: from_dict and to_dict, which can
110  be used to create (or output) a whole hierarchy of instances from (to) a
111  simple JSON-like dictionary notation (patch from Paul Johnston,
112  closes ticket #40).
113- Added experimental (!) support for concrete table inheritance (both
114  polymorphic or not). Concrete polymorphic inheritance requires SQLAlchemy
115  0.4.5 or later.
116- Moved the "entity to string" mapping and resolving code to the (newly
117  created) EntityCollection class (which stores lists of entities). This
118  allows one to provide a custom mapping method if needed. The default class
119  also overrides the __getattr__ method, providing and handy way to get at your
120  entities. See
121- Added new "identity" option which can be used to set a custom polymorphic
122  identity for an entity. It also accepts a callable so that you can generate
123  the identity name automatically from the class itself.
124- Added __setattr__ method on Metaclass so that you can add properties
125  slightly more easily after class definition (but *before* setup_all):
126    class A(Entity):
127        pass
128 = Field(String(32))
129- Added add_table_column, add_mapper_property and add_mapper_extension helper
130  methods in EntityBuilders.
131- Added full_tablename property on EntityDescriptor (includes schema name if
132  any).
133- Added on_reconstitute event/method decorator. Only works with SA 0.5.
134- Added support for viewonly relationships (OneToMany and OneToOne).
135- Added support for filtered OneToMany relationships. Produce viewonly
136  relations. See
137  for an example.
138- Added support for callables for some arguments on relationships: primaryjoin,
139  secondaryjoin and remote_side. It means those can be evaluated at setup time
140  (when tables and their columns already exist) instead of definition time.
143- Default "target entity resolving code" changed slightly. It now uses a global
144  collection keyed on the entity name. This means that entities can refer to
145  other entities in a different module simply with the target entity name
146  instead of its full path. The full path is only required when there is an
147  ambiguity (ie when there are two classes with the same name in two different
148  modules). Closes #9.
149- Added support for SQLAlchemy 0.5, and dropped support for version 0.3 and
150  earlier.
151- The default session (elixir.session) uses sessionmaker() instead of
152  create_session(), which means it has now the following characteristics:
153    * autoflush=True
154    * autocommit=False (with SA 0.5 -- equivalent to transactional=True with
155      SA 0.4)
156    * autoexpire=True (with SA 0.5).
157- removed objectstore and other SA 0.3 (or older) support code.
159Bug fixes:
160- Fixed multi-table inheritance when using a non default schema (closes #38)
161- Fixed ManyToOne relationships using 'key' kwarg in their column_kwargs
162  (patch by Jason R. Coombs)
163- Fixed inheritance with autoloaded entities: when using autoload, we
164  shouldn't try to add columns to the table (closes tickets #41 and #43).
165- Fixed acts_as_list extension with autoloaded entities (patch from maqr,
166  closes ticket #52).
167- Fixed ColumnProperty to work with latest version of SQLAlchemy (O.4.5 and
168  later)
169- Fixed ManyToMany relationships when not using the default schema
170  (patch from Diez B. Roggisch, closes ticket #48)
173- Added AUTHORS list. If you are missing from this list, don't hesitate to
174  contact me.
1760.5.2 - 2008-03-28
178New features:
179- Added an optional `check_concurrency` keyword argument to the versioning
180  extension, supporting the usage of SQLAlchemy's built-in optimistic
181  concurrency check.
184- Made Elixir python 2.3 compatible again (based on patches from
185  Jason R. Coombs)
187Bug fixes:
188- Fixed act_as_list extension to work with DBMS that require subselects to be
189  aliased (patch by Alice McGregor)
190- Fixed the versioning extension so that the history table is updated within
191  the current transaction (patch from and closes ticket #35).
1930.5.1 - 2008-02-07
195New features:
196- Added a new elixir plugin for managing entities as (ordered) lists.
197- Added a `column_format` keyword argument to `ManyToMany` which can be used
198  to specify an alternate format string for column names in the mapping table.
199- Added support for custom base classes which inherit from another class (ie
200  not directly from object).
201- Added an alternate (nicer) syntax to define synonym properties.  This syntax
202  has a more limited scope, except that it can refer to properties defined in
203  a parent entity. This is based on a patch from Alexandre da Silva.
206- Added check so that using an inexisting column in an order_by or other
207  column-name based argument raises an exception.
208- The polymorphic_identity kwarg in using_mapper_options is not overriden
209  anymore by the one generated by Elixir (patch from Ben Bangert).
210- Moved the format of the multi-table inheritance column to a constant in
211  options (so that it can be changed globally).
212- The foreign key constraint of the column in a multi-table inheritance is
213  configured with a cascade rule.
215Bug fixes:
216- A child entity doesn't inherit anymore its parent entity statements (such as
217  options) if it doesn't use any statement itself.
218- Made inheritance work for custom base classes (closes #25).
219- Fixed the inverse relationship matching when the inverse relationship is
220  defined in a parent Entity (thanks to Alexandre da Silva).
221- Fixed bug in setup_entities (it always used the global entity list and not
222  the list given as argument).
223- Fixed the versioning extension not appropriately handling versioned
224  entities with onupdate events (patch from Remi Jolin, closes #29).
225- Fixed videostore example (patch from Jason R. Coombs, closes #31).
2270.5.0 - 2007-12-08
229Please see for detailed
230upgrade notes.
232New features:
233- Added set method on base Entity (set attributes using kwargs)
236- Autosetup defaults to False ! (please look at those upgrade notes!)
237- Polymorphic defaults to True (inheritance is polymorphic by default).
238- Removed one of the autosetup triggers altogether: there is no "fake" mapper
239  registered in SQLAlchemy's mapper_registry anymore, so if you try to
240  access the class mapper directly (not through the 'mapper' attribute on
241  the class), before the setup phase happens, it won't work. This was done
242  because of a change in SQLAlchemy trunk (future SA 0.4.2) which broke that
243  piece of code (and prevented to use autosetup at all). Since that code
244  was a hack in the first place, instead of doing some even uglier hackery,
245  I got rid of it altogether.
246- Moved some format strings to constants in options, so that one can change
247  them if he wants to.
248- Allow overriding primary_key columns on autoloaded entities (closes tickets
249  #20 and #22)
250- Columns created by ManyToOne relationships can now optionally (through
251  column_kwargs) *not* create an index (ie it's not harcoded anymore).
252  Suggestion by Jason R. Coombs.
254Bug fixes:
255- Fixed a nasty bug which prevented inheritance to work correctly when using
256  the attribute syntax in many cases.
257- Fixed associable extension to work with SQLAlchemy trunk (future 0.4.2).
258- Fixed an incompatibility with zope.interfaces.
259- Tweaked the initialization sequence again (in fact revert an older change)
260  which prevented to reuse class properties of one class in other (subsequent)
261  classes.
262- Fixed our tests to work with SA trunk (future 0.4.2) (unicode data + use of
263  deprecated attributes)
2650.4.0 - 2007-10-29
267Please see for detailed
268upgrade notes.
270New features:
271- Implemented a new syntax to declare fields and relationships, much closer to
272  what is found in other Python ORM's. The with_fields syntax is now
273  deprecated in favor of a that new syntax. The old statement based (has_field
274  et al.) syntax is still available though (and will remain so for quite some
275  time). This was done with help from a patch by Adam Gomaa.
276- Implemented polymorphic single-table inheritance as well as polymorphic and
277  non-polymorphic multi-table (aka joined table) inheritance.
278- Added ext sub-package for additional Elixir statements.
279- Added associable extension for generating polymorphic associations with
280  Elixir statements.
281- Added versioning extension to keep track to all changes to your entities by
282  storing them in a secondary table.
283- Added encryption extenstion to encrypt/decrypt some fields data on the fly
284  when writing to/reading from the database.
285- Added support for synonym properties.
286- Added shortcut syntax to define column_properties.
287- Added a .query attribute on all entities. The old .query() syntax is still
288  available.
289- Added support to add any SQLAlchemy property on your mapper, through the
290  GenericProperty class (as well as the has_property statement). These can
291  work even if they rely on the entity columns (an thus need them to be
292  defined before the property can be declared). See tests/
293  for examples.
294- Added support for "manual session management" (ie you can now define an
295  entity with "using_options(session=None)" and it won't use any
296  SessionContext extension, nor receive the "query" attribute.
297- Made the statement system more powerfull.
300- The setup time was changed. That is the table and mapper are not created as
301  soon as the class is defined, but rather when first used, or when explicitly
302  calling the setup function (recommended). This also allowed us to reorder
303  the setup process and allows, among others to use a ManyToOne-generated
304  column as a primary key, to use unique constraints on those columns, to
305  order by those columns and so on...
306- Made Elixir work with both SQLAlchemy 0.4 and 0.3.10 (with help from a patch
307  by Ants Aasma).
308- Moved away from assign_mapper, now all assign_mapper-provided methods are on
309  the Entity class. Now, if people don't like them, they have the option to
310  simply provide another base class.
311- Default objectstore is now a ScopedSession when working on SQLAlchemy 0.4.
312  It means that it's not wrapped in an Objectstore object at all. This means,
313  that depending on the version of SA you are using, you'll get a slightly
314  different behavior.
315- Relationships to other classes can now also be defined using the classes
316  themselves in addition to the class namees. Obviously, this doesn't work for
317  forward references.
318- Classes defined inside a function can now have relationships to each other.
319- Added default __init__ method on entities so that subclasses can override it
320  and still have the "set attribute by keyword" behavior by calling super()
321- Added "through" and "via" keyword arguments on relationships and has_field
322  statement, to proxy values through relationships (uses association_proxy)
323- Made EntityMeta public, so that people can actually define their own base
324  class.
325- Changed the order of relationship kwargs processing so that computed kwargs
326  can be overridden by kwargs manually passed to the statement. This should
327  only be used if you know what you are doing.
328- Added onupdate kwarg to BelongsTo relationships for consistency with the
329  ondelete kwarg
330- Added ondelete and onupdate kwargs for use with has_and_belongs_to_many
331  to apply on delete clauses to foreign key constraints on the m2m table.
332- Columns of the intermediary table of an has_and_belongs_to_many relationship
333  are now marked as primary keys.
334- Reworked how entities look for primary keys on related entities. This
335  enables one "normal" entity (fully defined in Elixir) to refer to an entity
336  which is autoloaded.
337- Added translation (from column name to column object) of the primary_key
338  mapper option so that it can actually be used. This allows to have entities
339  without any primary key defined at the table level.
340- Added the possibility to give a custom name for ManyToOne constraints
341  (patch from and closes ticket #16)
342- Dropped support for the old threadlocal SA extension (which doesn't even exist
343  anymore in SA 0.4)
345Bug fixes:
346- Reworked/cleaned tests so that they don't leak stuff to other tests (both at
347  the method level and module level) anymore. Uses nosetest's module level
348  fixture.
349- Fixed relationships to entities whose primary_key field has been defined
350  with a "key" argument (based on a patch by Paul Johnston).
351- Fixed some buggy tests.
352- Fixed relationships to tables using a schema (patch by Neil Blakey-Milner)
353- Made inverse relationships use backrefs. This fixes the "bidirectional
354  coherency" problem some people had before doing a flush. (based on a patch
355  from Remi Jolin).
3570.3.0 - 2007-03-27
358- Made the provided metadata not threadlocal. This could break things for you
359  in some rare case. Please see the (newly created) FAQ file for details about
360  this.
361- Added support for autoloading/reflecting databases with
362  has_and_belongs_to_many relationships. The tablename argument is now
363  optional, but still recommended, otherwise you'll have to use the same exact
364  name for your intermediary table than the one generated. You also _have to_
365  specify at least one of either local_side or remote_side argument.
366- Added support for the "version_id_col" option on entities. This option adds
367  a column to the table which will be used to prevent concurrent modifications
368  on any row of the entity's table (i.e. it will raise an error if it happens).
369- Made the colname argument optional for belongs_to relationships in
370  autoloaded entities. It is only required to specify it if you have several
371  belongs_to relationships between two entities/tables.
372- Applied patch from "Wavy" so that columns of a table are in the same order
373  as they were declared (this only works for the has_field statement).
374- Applied patch from Isaac Csandl to add an "ondelete" argument to
375  belongs_to relationships. The content of that argument is forwarded to the
376  foreign key constraint.
377- Foreign key names generated by belongs_to relationships use column names
378  instead of relation names in case we have a relation with the same name
379  defined in several entities inheriting from the same entity using single-
380  table inheritance (and we set a custom column name in one of them to avoid
381  a column-name conflict).
382- Using invalid options on entities will now raise an exception
383- Added __version__
384- Use an explicit metaclass for entities, so that people can define their own
385  base class.
386- Changed the approach to reflecting/autoloading belongs_to relationships.
387  This shouldn't change anything to how it's used but allowed me to factor
388  some code with has_and_belongs_to_many relationships.
389- The tablename option can now be given a callable so that people can provide
390  their own function to get the table name for an entity. The tablename option
391  can now also be set globally (using the options_defaults dictionary). Of
392  course, this only makes sense for the callable usecase.
394- Fixed bug preventing having entities without any statement.
395- Fixed documentation for belongs_to relationships (the arguemnt is "required",
396  not "nullable").
397- Fixed typo which broke the use_alter argument on belongs_to relationships.
398- Fixed inheritance unit test to pass SQLAlchemy type check on relations
399  (introduced in SA 0.3.6)
400- Fixed wrong field length in autoload test (it was not noticeable with sqlite).
401- Actually make the code python 2.3 compatible (Robin's patch was based on
402  0.1.0 while I had introduced more decorators in the trunk in the mean time).
404- Made some PEP8 tweaks in many places. Used the pep8 script provided with
405  Cheesecake.
406- Some cleanup/useless code removal
4080.2.0 - 2007-02-28
409- Applied patch from Robin Munn to make the code python 2.3 compatible
410- Per a suggestion on the mailing list, look at the calling stack frame to
411  ensure that we apply statements to the proper class.  We now attach the
412  statement list to the class itself, rather than attaching it to a global
413  list that is neither threadsafe, nor safe when doing nested class
414  definition.  Also added a test to validate that this works.
415- implemented singletable non-polymorphic inheritance
416- added support to pass non-keyword arguments to tables. You just pass
417  them to the using_table_options statement and they will be forwarded to the
418  table along with the keyword arguments. This can be used to set table
419  constraints.
420- added support for deferred columns (use the "deferred" keyword argument on
421  fields)
422- added a "required" keyword argument on fields and BelongsTo
423  relationships. This is the opposite of the "nullable" SA argument.
424- added a "column_kwargs" keyword argument to BelongsTo relationships
425  to forward any keyword argument directly to the SA Column.
426- added support for the use_alter and constraint_kwargs kwargs on BelongsTo
427  relationships (forwarded to SA ForeignKeyConstraint).
428    -> removed the systematic use_alter on BelongsTo relations since it
429       can now be specified only when needed.
430    -> removed it from HasAndBelongsToMany relations, since I think a
431       circular foreign key dependency can't happen with those relations.
432- fixed foreign key names on MySQL (and possibly other) databases by
433  making sure the generated name is unique for the whole database, and not
434  only for the table on which it applies.
435- corrected some docstrings
4370.1.0 - 2007-02-12
438initial release
Note: See TracBrowser for help on using the browser.