diff --git a/docs/source/autodoc/index.rst b/docs/source/autodoc/index.rst index b498f537..9854ccb2 100644 --- a/docs/source/autodoc/index.rst +++ b/docs/source/autodoc/index.rst @@ -12,5 +12,5 @@ It may be incomplete or outdated, as it is automatically updated. campaigns engineer lazy + royaltyping scrolls - types diff --git a/docs/source/autodoc/royaltyping.rst b/docs/source/autodoc/royaltyping.rst new file mode 100644 index 00000000..fe4670d7 --- /dev/null +++ b/docs/source/autodoc/royaltyping.rst @@ -0,0 +1,7 @@ +``royaltyping`` - Additional type information +============================================= + +.. currentmodule:: royalnet.royaltyping +.. automodule:: royalnet.royaltyping + :members: + :undoc-members: diff --git a/docs/source/autodoc/types.rst b/docs/source/autodoc/types.rst deleted file mode 100644 index a682ebd4..00000000 --- a/docs/source/autodoc/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -``types`` - Additional type information -======================================= - -.. currentmodule:: royalnet.types -.. automodule:: royalnet.types - :members: - :undoc-members: diff --git a/royalnet/alchemist/make.py b/royalnet/alchemist/make.py index 40686dac..34c7e6bb 100644 --- a/royalnet/alchemist/make.py +++ b/royalnet/alchemist/make.py @@ -1,4 +1,4 @@ -from royalnet.types import * +from royalnet.royaltyping import * import sqlalchemy.orm as o diff --git a/royalnet/campaigns/asynccampaign.py b/royalnet/campaigns/asynccampaign.py index 7ae2f00e..00324dbf 100644 --- a/royalnet/campaigns/asynccampaign.py +++ b/royalnet/campaigns/asynccampaign.py @@ -1,5 +1,5 @@ from __future__ import annotations -from royalnet.types import * +from royalnet.royaltyping import * import logging import inspect import datetime diff --git a/royalnet/campaigns/asyncchallenge.py b/royalnet/campaigns/asyncchallenge.py index 10fcfbd1..cc1b689f 100644 --- a/royalnet/campaigns/asyncchallenge.py +++ b/royalnet/campaigns/asyncchallenge.py @@ -1,4 +1,4 @@ -from royalnet.types import * +from royalnet.royaltyping import * import abc __all__ = ( diff --git a/royalnet/campaigns/campaign.py b/royalnet/campaigns/campaign.py index f51bef51..c3920440 100644 --- a/royalnet/campaigns/campaign.py +++ b/royalnet/campaigns/campaign.py @@ -1,5 +1,5 @@ from __future__ import annotations -from royalnet.types import * +from royalnet.royaltyping import * import logging import inspect import datetime diff --git a/royalnet/campaigns/challenge.py b/royalnet/campaigns/challenge.py index d1fd6b5a..bad1b406 100644 --- a/royalnet/campaigns/challenge.py +++ b/royalnet/campaigns/challenge.py @@ -1,4 +1,4 @@ -from royalnet.types import * +from royalnet.royaltyping import * import abc __all__ = ( diff --git a/royalnet/engineer/params.py b/royalnet/engineer/params.py index 178f8a8c..a3505d88 100644 --- a/royalnet/engineer/params.py +++ b/royalnet/engineer/params.py @@ -1,11 +1,11 @@ -from royalnet.types import * +from royalnet.royaltyping import * import pydantic import inspect class ModelConfig(pydantic.BaseConfig): """ - A :mod:`pydantic` model config which allows for arbitrary types. + A :mod:`pydantic` model config which allows for arbitrary royaltyping. """ arbitrary_types_allowed = True diff --git a/royalnet/engineer/router.py b/royalnet/engineer/router.py index ea24f093..d0ec6d76 100644 --- a/royalnet/engineer/router.py +++ b/royalnet/engineer/router.py @@ -1,6 +1,6 @@ import functools import pydantic -from royalnet.types import * +from royalnet.royaltyping import * from . import params diff --git a/royalnet/lazy/lazy.py b/royalnet/lazy/lazy.py index 13f82ebe..78ab0299 100644 --- a/royalnet/lazy/lazy.py +++ b/royalnet/lazy/lazy.py @@ -1,5 +1,5 @@ from __future__ import annotations -from royalnet.types import * +from royalnet.royaltyping import * Result = TypeVar("Result") diff --git a/royalnet/types/__init__.py b/royalnet/royaltyping/__init__.py similarity index 92% rename from royalnet/types/__init__.py rename to royalnet/royaltyping/__init__.py index 46f68ebe..4372f887 100644 --- a/royalnet/types/__init__.py +++ b/royalnet/royaltyping/__init__.py @@ -1,9 +1,9 @@ """ -This module adds some new common types to the default typing package. +This module adds some new common royaltyping to the default typing package. It should be imported with: :: - from royalnet.types import * + from royalnet.royaltyping import * """ diff --git a/royalnet/scrolls/__init__.py b/royalnet/scrolls/__init__.py index a6f3e228..7be8d7e7 100644 --- a/royalnet/scrolls/__init__.py +++ b/royalnet/scrolls/__init__.py @@ -4,7 +4,7 @@ from :data:`os.environ`. """ from __future__ import annotations -from royalnet.types import * +from royalnet.royaltyping import * import os import re import toml