Entity relationship diagrams for Python data model classes like Pydantic
StopIteration error when rendering a model that has no fields. (Issue #120, PR #121)AttributeError when adding a model that has a field annotated with certain typing special forms like Any, Literal, or TypeVar instances. (Issue #114, PR #115)ModuleNotFoundError when importing from erdantic.examples without attrs installed.[!IMPORTANT] This release features significant changes to erdantic, primarily to the backend process of analyzing models and representing data. If you have been primarily using the CLI or the convenience functions
create,draw, andto_dot, then your code may continue to work without any changes. If you are doing something more advanced, you may need to update your code.
--termini option. Use the new --terminal-model option instead. The shorthand option -t remains the same. The --termini option still works but will emit a deprecation warning.termini argument for create, draw, and to_dot functions. Use the new terminal_models argument instead. The termini argument still works but will emit a deprecation warning.graph_attr, node_attr, and edge_attr arguments to the draw and to_dot functions that allow you to override attributes on the generated pygraphviz object for the diagram.A few changes have been made to the visual content of rendered diagrams.
List[TargetModel]) to display as a "many" relationship (crow) instead of a "zero-or-many" relationship (odot + crow), treating the modality of the field as unspecified. A field will only be displayed as "zero-or-many" (odot + crow) if it is explicitly optional, like Optional[List[TargetModel]].attrs.define. The source code for attrs support can be found in the new module erdantic.plugins.attrs.erdantic.examples.attrs.Significant changes have been made to the library backend to more strongly separate the model analysis process, the extracted data, and the diagram rendering process. We believe this more structured design facilitates customizing diagrams and simplifies the implementation for each data modeling framework. Please see the new documentation pages "Customizing diagrams" and "Extending or modifying erdantic" for details on the new design.
A summary of some key changes is below:
Model and Field and the conrete adapters DataClassModel, DataClassField, PydanticModel, and PydanticField.
ModelInfo and FieldInfo to replace the adapter system. These new models hold static data that have been extracted from models that erdantic analyzed.model_adapter_registry and register_model_adapter.
register_plugin. All objects related to plugins can be found in the new erdantic.plugins module and its submodules.erdantic.typing module to erdantic.typing_utils.py.typed marker file to indicate that the package supports type checking.EntityRelationshipDiagram instances.This will be the last version that supports Python 3.7.
< 0.10.0 due to incompatibility with a fix introduced in that version.This is a pre-release version for v1.0.0.
[!IMPORTANT] This release features significant changes to erdantic, primarily to the backend process of analyzing models and representing data. If you have been primarily using the CLI or the convenience functions
create,draw, andto_dot, then your code may continue to work without any changes. If you are doing something more advanced, you may need to update your code.
--termini option. Use the new --terminal-model option instead. The shorthand option -t remains the same. The --termini option still works but will emit a deprecation warning.termini argument for create, draw, and to_dot functions. Use the new terminal_models argument instead. The termini argument still works but will emit a deprecation warning.graph_attr, node_attr, and edge_attr arguments to the draw and to_dot functions that allow you to override attributes on the generated pygraphviz object for the diagram.A few changes have been made to the visual content of rendered diagrams.
List[TargetModel]) to display as a "many" relationship (crow) instead of a "zero-or-many" relationship (odot + crow), treating the modality of the field as unspecified. A field will only be displayed as "zero-or-many" (odot + crow) if it is explicitly optional, like Optional[List[TargetModel]].attrs.define. The source code for attrs support can be found in the new module erdantic.plugins.attrs.erdantic.examples.attrs.Significant changes have been made to the library backend to more strongly separate the model analysis process, the extracted data, and the diagram rendering process. We believe this more structured design facilitates customizing diagrams and simplifies the implementation for each data modeling framework. Please see the new documentation pages "Customizing diagrams" and "Extending or modifying erdantic" for details on the new design.
A summary of some key changes is below:
Model and Field and the conrete adapters DataClassModel, DataClassField, PydanticModel, and PydanticField.
ModelInfo and FieldInfo to replace the adapter system. These new models hold static data that have been extracted from models that erdantic analyzed.model_adapter_registry and register_model_adapter.
register_plugin. All objects related to plugins can be found in the new erdantic.plugins module and its submodules.erdantic.typing module to erdantic.typing_utils.py.typed marker file to indicate that the package supports type checking.EntityRelationshipDiagram instances.PydanticField to work with Pydantic V2's API.is_many and is_nullable functions to erdantic.typing.