Skip to main content

Codebase layout

Package root​

  • src/fino_filing/ — Main package. Public API is re-exported from __init__.py via __all__.

Source structure​

src/fino_filing/
├── __init__.py          # Public API (Collection, Filing, Catalog, Collector, etc.)
├── core/
│   └── error.py         # FinoFilingException base
├── collection/          # Collection boundary (Facade + storage/index)
│   ├── collection.py    # Collection (Facade)
│   ├── catalog.py      # Catalog (DuckDB index, search)
│   ├── filing_resolver.py  # FilingResolver, default_resolver, register_filing_class
│   ├── locator.py      # Locator (Filing → storage path)
│   ├── storage.py      # Storage Protocol
│   ├── storages/
│   │   └── local.py    # LocalStorage
│   └── error.py        # CollectionChecksumMismatchError, LocatorPathResolutionError, ...
├── filing/              # Filing boundary
│   ├── filing.py       # Filing, FilingMeta
│   ├── field.py        # Field (descriptor, DSL)
│   ├── meta.py         # FilingMeta implementation
│   ├── expr.py         # Expr (query expression)
│   ├── filing_edinet.py  # EDINETFiling
│   ├── filing_edgar.py  # EdgarFiling, EdgarCompanyFactsFiling
│   └── error.py        # FilingRequiredError, FieldValidationError, ...
└── collector/           # Collector boundary
    ├── base.py         # BaseCollector, RawDocument, Parsed
    ├── edinet/         # EDINET 提出
    │   └── collector.py
    └── edgar/          # SEC Edgar（種別ごとサブパッケージ）
        ├── client.py
        ├── config.py
        ├── _helpers.py
        ├── documents/  # 提出書類 → EdgarFiling
        │   └── collector.py
        ├── facts/      # Company Facts → EdgarCompanyFactsFiling
        │   └── collector.py
        └── bulk/       # Bulk（スタブ）→ EdgarFiling
            └── collector.py