Filing

Document model with a metaclass-defined schema. Core fields are fixed; subclasses add fields via Annotated[str, Field(...)].

Constructor

Filing(**kwargs) -> Filing

• kwargs: Field values (e.g. source, name, checksum, format, is_zip). Omit id and created_at to have them auto-generated.
• Raises: FilingRequiredError if a required field is missing or None; FilingValidationError / FieldValidationError on type mismatch; FieldImmutableError when reassigning an immutable field after init.

Identity and ID generation

• ID hash fields: If any user-defined field uses Field(..., identifier=True), only those fields (sorted by name) are concatenated and hashed for auto-generated id. Otherwise, behavior matches identity fields below (backward compatible).
• Identity fields: Core set source, name, is_zip, format plus all user-defined fields (excluding id, created_at, checksum). Used for deterministic id when no identifier=True fields exist.
• id: If not provided, computed as SHA256(ID hash field values)[:32].
• created_at: If not provided, set to datetime.now().

Instance methods

Method	Returns	Description
to_dict()	dict[str, Any]	Flat dict of all fields; datetime → ISO string
get(key: str)	Any	Value for key

Class methods

Method	Returns	Description
from_dict(cls, data: dict) -> Self	Filing instance	Restore from dict; datetime strings are parsed. Raises same as constructor when keys/types invalid.

Attributes (core)

All filings have these fields. Required unless noted.

Field	Type	Required	Indexed	Immutable	Description
id	str	yes	yes	yes	Filing ID (auto-generated from identity fields if omitted)
source	str	yes	yes	yes	Data source（例: "EDGAR", "EDINET"）
checksum	str	yes	yes	no	SHA256 hex digest of content
name	str	yes	yes	yes	File name
is_zip	bool	yes	yes	no	Whether content is ZIP
format	str	yes	yes	yes	Format / extension (e.g. xbrl, zip, pdf)
created_at	datetime	yes	yes	yes	Created timestamp (auto-generated if omitted)

Custom Filing subclasses

You can define your own Filing type by subclassing Filing and declaring additional fields with Annotated[str, Field(...)] (or other types). The metaclass handles schema registration, identity, and validation. Register your subclass on a FilingResolver (e.g. used by Catalog) so instances can be restored from storage.

組み込みサブクラス: EDINETFiling（source="EDINET"）; EdgarArchiveFiling / EdgarBulkFiling / EdgarCompanyFactsFiling（いずれも source="EDGAR"）。いずれも default_resolver に登録され、Catalog から復元可能。