Type annotations / type hints / stub files for mypy

[MartinThoma]

Are there plans to add type annotations or stub files for mypy?

I've written an article about type annotations if you need one :-)

[rochacbruno]

@MartinThoma pull requests adding annotations and stubs are very welcome.

[MartinThoma]

I see that you're supporting Python 3.6+. Then I would prefer type annotations instead of stub files. I'll prepare something once I have some time :-)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[disrupted]

commenting because this is still a valid and desired request, therefore shouldn't be closed

[SonGokussj4]

Still valid even year later. Any progress? I tried to implement some dataclasses with pydantic but faild. Does anyone have a working workaround?

[MartinThoma]

I no longer use dynaconf

[rochacbruno]

I am working on #683 adding type annotations

[FeryET]

Any update on this?

[apowers313]

Here was my workaround: convert the Dynaconf config into a Pydantic BaseModel. Pydantic does all the validation and defaults and creates a strongly-typed config.

The code is a bit long (but conceptually very simple) because it has to account for all the default Dynaconf fields, so the Gist is here: https://gist.github.com/apowers313/c009991a31195e9e3ee8dc51b989136a

[LukeSavefrogs]

Yet another workaround inspired by @apowers313 approach:

# -------------- src/package/config/schemas.py -------------- 
import dataclasses
from pathlib import Path

from dynaconf import Dynaconf

@dataclasses.dataclass
class SettingsSchema(Dynaconf):
    myProperty: str
    myCategory: "CategorySettingsSchema"


@dataclasses.dataclass
class CategorySettingsSchema:
    mySecondProperty: int




# -------------- src/package/config/__init__.py -------------- 
from dynaconf import Dynaconf
from package.config.schemas import SettingsSchema

settings: SettingsSchema = Dynaconf(  # pyright: ignore[reportGeneralTypeIssues]
    ...
)

Please note that:

• this method relies entirely on forcing type casting on the Dynaconf object
• The line # pyright: ignore[reportGeneralTypeIssues] is needed in order to ignore the PyLance error when trying to cast the Dynaconf object to SettingsSchema.

Pros and cons

Compared to @apowers313 solution this one has the following pros/cons:

PROS:

• Less verbose
• Does not need any other dependency installed (dataclasses is shipped with Python)

CONS:

• Only access the contents of the configuration files (cannot access environment or Dynaconf variables)
• Provides type hinting only when accessing properties via the dot operator (settings.property.subproperty)

For simpler configurations like mine could be useful.