sqlalchemy.orm.decl_base._ClassScanMapperConfig

class documentation

class _ClassScanMapperConfig(_MapperConfig): (source)

Known subclasses: sqlalchemy.orm.decl_base._DeferredMapperConfig

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method map Undocumented
Class Variable __slots__ Undocumented
Class Variable is_deferred Undocumented
Instance Variable allow_dataclass_fields if true, look for dataclass-processed Field objects on the target class as well as superclasses and extract ORM mapping directives from the "metadata" attribute of each Field.
Instance Variable allow_unmapped_annotations Undocumented
Instance Variable clsdict_view Undocumented
Instance Variable collected_annotations Undocumented
Instance Variable collected_attributes Undocumented
Instance Variable column_copies Undocumented
Instance Variable column_ordering Undocumented
Instance Variable dataclass_setup_arguments if the class has SQLAlchemy native dataclass parameters, where we will turn the class into a dataclass within the declarative mapping process.
Instance Variable declared_columns Undocumented
Instance Variable inherits Undocumented
Instance Variable is_dataclass_prior_to_mapping Undocumented
Instance Variable local_table Undocumented
Instance Variable mapper_args Undocumented
Instance Variable mapper_args_fn Undocumented
Instance Variable persist_selectable Undocumented
Instance Variable registry Undocumented
Instance Variable table_args Undocumented
Instance Variable tablename Undocumented
Class Method _apply_dataclasses_to_any_class Undocumented
Class Method _assert_dc_arguments Undocumented
Class Method _update_annotations_for_non_mapped_class Undocumented
Method _cls_attr_override_checker Produce a function that checks if a class has overridden an attribute, taking SQLAlchemy-enabled dataclass fields into account.
Method _cls_attr_resolver produce a function to iterate the "attributes" of a class which we want to consider for mapping, adjusting for SQLAlchemy fields embedded in dataclass fields.
Method _collect_annotation Undocumented
Method _extract_declared_columns Undocumented
Method _extract_mappable_attributes Undocumented
Method _metadata_for_cls Undocumented
Method _prepare_mapper_arguments Undocumented
Method _produce_column_copies Undocumented
Method _scan_attributes Undocumented
Method _setup_dataclasses_transforms Undocumented
Method _setup_declared_events Undocumented
Method _setup_inheriting_columns Undocumented
Method _setup_inheriting_mapper Undocumented
Method _setup_table Undocumented
Method _warn_for_decl_attributes Undocumented
Class Variable _include_dunders Undocumented
Class Variable _match_exclude_dunders Undocumented

Inherited from _MapperConfig:

Class Method setup_mapping Undocumented
Method set_cls_attribute Undocumented
Instance Variable classname Undocumented
Instance Variable cls Undocumented
Instance Variable declared_attr_reg Undocumented
Instance Variable properties Undocumented
Method _early_mapping Undocumented
def __init__(self, registry: _RegistryType, cls_: Type[_O], dict_: _ClassDict, table: Optional[FromClause], mapper_kw: _MapperKwArgs): (source)
overrides sqlalchemy.orm.decl_base._MapperConfig.__init__

Undocumented

def map(self, mapper_kw: _MapperKwArgs = util.EMPTY_DICT) -> Mapper[Any]: (source)
overrides sqlalchemy.orm.decl_base._MapperConfig.map
overridden in sqlalchemy.orm.decl_base._DeferredMapperConfig

Undocumented

__slots__: tuple[str, ...] = (source)
overrides sqlalchemy.orm.decl_base._MapperConfig.__slots__

Undocumented

is_deferred: bool = (source)
overridden in sqlalchemy.orm.decl_base._DeferredMapperConfig

Undocumented

allow_dataclass_fields = (source)

if true, look for dataclass-processed Field objects on the target class as well as superclasses and extract ORM mapping directives from the "metadata" attribute of each Field. if False, dataclass fields can still be used, however they won't be mapped.

allow_unmapped_annotations = (source)

Undocumented

clsdict_view = (source)

Undocumented

collected_annotations: dict = (source)

Undocumented

collected_attributes: dict = (source)

Undocumented

column_copies: dict = (source)

Undocumented

column_ordering: dict = (source)

Undocumented

dataclass_setup_arguments = (source)

if the class has SQLAlchemy native dataclass parameters, where we will turn the class into a dataclass within the declarative mapping process.

declared_columns = (source)

Undocumented

inherits = (source)

Undocumented

is_dataclass_prior_to_mapping = (source)

Undocumented

local_table = (source)

Undocumented

mapper_args = (source)

Undocumented

mapper_args_fn = (source)

Undocumented

persist_selectable = (source)

Undocumented

registry = (source)

Undocumented

table_args = (source)

Undocumented

tablename = (source)

Undocumented

@classmethod
def _apply_dataclasses_to_any_class(cls, dataclass_setup_arguments: _DataclassArguments, klass: Type[_O], use_annotations: Mapping[str, _AnnotationScanType]): (source)

Undocumented

@classmethod
def _assert_dc_arguments(cls, arguments: _DataclassArguments): (source)

Undocumented

@classmethod
def _update_annotations_for_non_mapped_class(cls, klass: Type[_O]) -> Mapping[str, _AnnotationScanType]: (source)

Undocumented

def _cls_attr_override_checker(self, cls: Type[_O]) -> Callable[[str, Any], bool]: (source)

Produce a function that checks if a class has overridden an attribute, taking SQLAlchemy-enabled dataclass fields into account.

def _cls_attr_resolver(self, cls: Type[Any]) -> Callable[[], Iterable[Tuple[str, Any, Any, bool]]]: (source)

produce a function to iterate the "attributes" of a class which we want to consider for mapping, adjusting for SQLAlchemy fields embedded in dataclass fields.

def _collect_annotation(self, name: str, raw_annotation: _AnnotationScanType, originating_class: Type[Any], expect_mapped: Optional[bool], attr_value: Any) -> Optional[_CollectedAnnotation]: (source)

Undocumented

def _extract_declared_columns(self): (source)

Undocumented

def _extract_mappable_attributes(self): (source)

Undocumented

def _metadata_for_cls(self, manager: ClassManager[Any]) -> MetaData: (source)

Undocumented

def _prepare_mapper_arguments(self, mapper_kw: _MapperKwArgs): (source)

Undocumented

def _produce_column_copies(self, attributes_for_class: Callable[[], Iterable[Tuple[str, Any, Any, bool]]], attribute_is_overridden: Callable[[str, Any], bool], fixed_table: bool, originating_class: Type[Any]) -> Dict[str, Union[Column[Any], MappedColumn[Any]]]: (source)

Undocumented

def _scan_attributes(self): (source)

Undocumented

def _setup_dataclasses_transforms(self): (source)

Undocumented

def _setup_declared_events(self): (source)

Undocumented

def _setup_inheriting_columns(self, mapper_kw: _MapperKwArgs): (source)

Undocumented

def _setup_inheriting_mapper(self, mapper_kw: _MapperKwArgs): (source)

Undocumented

def _setup_table(self, table: Optional[FromClause] = None): (source)

Undocumented

def _warn_for_decl_attributes(self, cls: Type[Any], key: str, c: Any): (source)

Undocumented

_include_dunders: set[str] = (source)

Undocumented

_match_exclude_dunders = (source)

Undocumented