ImportError: cannot import name 'metadata' from ...

[walter-weinmann]

Can someone please help me with this problem?

Directory structure:

Pytest run:

walter@ubuntu:/mnt/hgfs/Projects/dcr$ make pytest
Info **********  Start: pytest **************************************
src/dcr:src/dcr
pipenv run pytest --version
pytest 7.0.0
pipenv run pytest --dead-fixtures tests
ImportError while loading conftest '/mnt/hgfs/Projects/dcr/tests/conftest.py'.
tests/conftest.py:19: in <module>
    from libs.cfg import metadata
E   ImportError: cannot import name 'metadata' from 'libs.cfg' (/mnt/hgfs/Projects/dcr/src/dcr/libs/cfg.py)

Installed packages:.

pipenv run pip freeze
astroid==2.9.3
attrs==21.4.0
bandit==1.7.2
black==22.1.0
certifi==2021.10.8
charset-normalizer==2.0.11
click==8.0.3
coverage==6.3.1
coveralls==3.3.1
docopt==0.6.2
flake8==4.0.1
future==0.18.2
ghp-import==2.0.2
gitdb==4.0.9
GitPython==3.1.26
greenlet==1.1.2
idna==3.3
importlib-metadata==4.10.1
iniconfig==1.1.1
isort==5.10.1
Jinja2==3.0.3
lazy-object-proxy==1.7.1
mando==0.6.4
Markdown==3.3.6
MarkupSafe==2.0.1
mccabe==0.6.1
mergedeep==1.3.4
mkdocs==1.2.3
mkdocs-material==8.1.10
mkdocs-material-extensions==1.0.3
mypy==0.931
mypy-extensions==0.4.3
packaging==21.3
pathspec==0.9.0
pbr==5.8.1
platformdirs==2.4.1
pluggy==1.0.0
py==1.11.0
pycodestyle==2.8.0
pydocstyle==6.1.1
pyflakes==2.4.0
Pygments==2.11.2
pylint==2.12.2
pymdown-extensions==9.1
pyparsing==3.0.7
pytest==7.0.0
pytest-cov==3.0.0
pytest-deadfixtures==2.2.1
pytest-random-order==1.0.4
python-dateutil==2.8.2
PyYAML==6.0
pyyaml_env_tag==0.1
radon==5.1.0
requests==2.27.1
six==1.16.0
smmap==5.0.0
snowballstemmer==2.2.0
SQLAlchemy==1.4.31
sqlalchemy-stubs==0.4
stevedore==3.5.0
toml==0.10.2
tomli==2.0.0
touch==2020.12.3
types-PyYAML==6.0.4
typing_extensions==4.0.1
urllib3==1.26.8
values==2020.12.3
watchdog==2.1.6
wrapt==1.13.3
zipp==3.7.0

[The-Compiler]

Well, does your libs/cfg.py have a thing called metadata in it?

[walter-weinmann]

Sure - it is all running fine except with pytest:

libs/cfg.py:

"""Definition of the Global Constants, Types and Variables."""

from os import PathLike
from typing import Dict
from typing import TypeAlias
from typing import Union

import sqlalchemy
from sqlalchemy import MetaData
from sqlalchemy.engine import Engine

# -----------------------------------------------------------------------------
# Global Constants.
# -----------------------------------------------------------------------------
ACTION_ALL_COMPLETE: str = "all"
ACTION_CREATE_DB: str = "db_c"
ACTION_PROCESS_INBOX: str = "p_i"

CURRENT_FILE_NAME : str
CURRENT_FILE_TYPE : str
CURRENT_STEM_NAME : str

DBC_ACTION: str = "action"
DBC_CREATED_AT: str = "created_at"
DBC_DOCUMENT_ID: str = "document_id"
DBC_FILE_NAME: str = "file_name"
DBC_FILE_TYPE: str = "file_type"
DBC_FUNCTION: str = "function"
DBC_ID: str = "id"
DBC_INBOX_ABS_NAME: str = "inbox_abs_name"
DBC_INBOX_CONFIG: str = "inbox_config"
DBC_INBOX_ACCEPTED_ABS_NAME: str = "inbox_accepted_abs_name"
DBC_INBOX_ACCEPTED_CONFIG: str = "inbox_accepted_config"
DBC_INBOX_REJECTED_ABS_NAME: str = "inbox_rejected_abs_name"
DBC_INBOX_REJECTED_CONFIG: str = "inbox_rejected_config"
DBC_MODIFIED_AT: str = "modified_at"
DBC_MODULE: str = "module"
DBC_PACKAGE: str = "package"
DBC_RUN_ID: str = "run_id"
DBC_STATUS: str = "status"
DBC_STEM_NAME: str = "stem_name"
DBC_TOTAL_ACCEPTED: str = "total_accepted"
DBC_TOTAL_NEW: str = "total_new"
DBC_TOTAL_REJECTED: str = "total_rejected"
DBC_VERSION: str = "version"

DBT_DOCUMENT: str = "document"
DBT_JOURNAL: str = "journal"
DBT_RUN: str = "run"
DBT_VERSION: str = "version"

DCR_ARGV_0: str = "src/dcr/dcr.py"
DCR_CFG_DATABASE: str = "database"
DCR_CFG_DATABASE_FILE: str = "database_file"
DCR_CFG_DATABASE_URL: str = "database_url"
DCR_CFG_DCR_VERSION: str = "dcr_version"
DCR_CFG_DIRECTORY_INBOX: str = "directory_inbox"
DCR_CFG_DIRECTORY_INBOX_ACCEPTED: str = "directory_inbox_accepted"
DCR_CFG_DIRECTORY_INBOX_REJECTED: str = "directory_inbox_rejected"
DCR_CFG_FILE: str = "setup.cfg"
DCR_CFG_SECTION: str = "dcr"

FILE_ENCODING_DEFAULT: str = "utf-8"
FILE_TYPE_DOC: str = "doc"
FILE_TYPE_DOCX: str = "docx"
FILE_TYPE_JPEG: str = "jpeg"
FILE_TYPE_JPG: str = "jpg"
FILE_TYPE_PDF: str = "pdf"
FILE_TYPE_TXT: str = "txt"

LOCALE: str = "en_US.UTF-8"
LOGGER_CFG_FILE: str = "logging_cfg.yaml"
LOGGER_END: str = "End"
LOGGER_FATAL_HEAD: str = "FATAL ERROR: program abort =====> "
LOGGER_FATAL_TAIL: str = " <===== FATAL ERROR"
LOGGER_PROGRESS_UPDATE: str = "Progress update "
LOGGER_START: str = "Start"

STATUS_END: str = "end"
STATUS_INVALID_FILE_TYPE: str = "invalid_file_type"
STATUS_NEW: str = "new"
STATUS_NEXT_PANDOC: str = "next_pandoc"
STATUS_NEXT_TESSERACT: str = "next_tesseract"
STATUS_START: str = "start"

# -----------------------------------------------------------------------------
# Global Type Definitions.
# -----------------------------------------------------------------------------
Columns: TypeAlias = list[Dict[str, Union[PathLike[str], str]]]

# -----------------------------------------------------------------------------
# Global Variables.
# -----------------------------------------------------------------------------
config: Dict[str, PathLike[str] | str] = {}

engine: Engine

inbox: PathLike[str] | str
inbox_accepted: PathLike[str] | str
inbox_rejected: PathLike[str] | str

metadata: MetaData

run_id: sqlalchemy.Integer

total_accepted: int = 0
total_new: int = 0
total_rejected: int = 0

[The-Compiler]

Your file merely declares a type for metadata, it does not set it to any value. I'm not sure how this could work outside of pytest, or what makes you expect it would work in pytest.

With your file saved as cfg.py:

$ python3 -c "from cfg import metadata"
Traceback (most recent call last):
  File "<string>", line 1, in <module>
ImportError: cannot import name 'metadata' from 'cfg' (/home/florian/tmp/cfg.py)

[walter-weinmann]

@The-Compiler thanks a lot - this really solved the problem:

metadata: MetaData | None = None