diff --git a/docs/source/conf.py b/docs/source/conf.py index 1be49fc..6a71312 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -34,7 +34,6 @@ "sphinx.ext.todo", "sphinx.ext.viewcode", "autodoc2", - "sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinxcontrib_django", ] diff --git a/signoffs/core/approvals.py b/signoffs/core/approvals.py index 1151245..bea5249 100644 --- a/signoffs/core/approvals.py +++ b/signoffs/core/approvals.py @@ -177,7 +177,7 @@ def can_revoke_signoff(self, approval, signoff): class ApprovalLogic(DefaultApprovalBusinessLogic): - """ Public API: Alias for `DefaultApprovalBusinessLogic """ + """Public API: Alias for `DefaultApprovalBusinessLogic""" class AbstractApproval: @@ -501,6 +501,10 @@ class BaseApproval(AbstractApproval): stampModel = None -__all__ =[ - 'revoke_approval', 'AbstractApproval', 'BaseApproval', 'DefaultApprovalBusinessLogic', 'ApprovalLogic' -] \ No newline at end of file +__all__ = [ + "revoke_approval", + "AbstractApproval", + "BaseApproval", + "DefaultApprovalBusinessLogic", + "ApprovalLogic", +] diff --git a/signoffs/core/forms.py b/signoffs/core/forms.py index 77e67bb..4cfca5d 100644 --- a/signoffs/core/forms.py +++ b/signoffs/core/forms.py @@ -259,10 +259,11 @@ class SignoffFormsManager(class_service(service_class=SignoffTypeForms)): - OR both... `MySignoffFormsManager = utils.service(MyInstanceForms)` """ + __all__ = [ "AbstractSignoffForm", "signoff_form_factory", "AbstractSignoffRevokeForm", "revoke_form_factory", - "SignoffFormsManager" + "SignoffFormsManager", ] diff --git a/signoffs/core/process.py b/signoffs/core/process.py index f0ba97f..a8b87bb 100644 --- a/signoffs/core/process.py +++ b/signoffs/core/process.py @@ -820,4 +820,4 @@ def has_revoke_perm(instance, user): "ApprovalsProcess", "FsmApprovalsProcess", "user_can_revoke_approval", -] \ No newline at end of file +] diff --git a/signoffs/core/renderers/approvals.py b/signoffs/core/renderers/approvals.py index b0b8b4b..931c963 100644 --- a/signoffs/core/renderers/approvals.py +++ b/signoffs/core/renderers/approvals.py @@ -86,12 +86,6 @@ def resolve_approval_context(self, context, **kwargs): return approval_context -""" -A descriptor class that "injects" a ApprovalInstanceRenderer instance into a Approval instance. -To inject custom rendering services: - - instantiate the descriptor with a custom service_class: ApprovalRenderer(service_class=MyInstanceRenderer); - - OR use utils.service to define a new renderer service descriptor class -""" class ApprovalRenderer(utils.service(ApprovalInstanceRenderer)): """ A descriptor class that "injects" a `ApprovalInstanceRenderer` instance into a Approval instance. diff --git a/signoffs/core/signing_order/__init__.py b/signoffs/core/signing_order/__init__.py index 5119c18..3c5f667 100644 --- a/signoffs/core/signing_order/__init__.py +++ b/signoffs/core/signing_order/__init__.py @@ -1,4 +1,8 @@ -from .signing_order import SigningOrder, SigningOrderStrategyProtocol, SigningOrderPatternMatcher +from .signing_order import ( + SigningOrder, + SigningOrderPatternMatcher, + SigningOrderStrategyProtocol, +) from .signoff_pattern import ( AnyOneOf, AtLeastN, diff --git a/signoffs/core/signing_order/signing_order.py b/signoffs/core/signing_order/signing_order.py index 88e44d7..304b67f 100644 --- a/signoffs/core/signing_order/signing_order.py +++ b/signoffs/core/signing_order/signing_order.py @@ -116,5 +116,7 @@ def __get__(self, instance, owner=None): __all__ = [ - "SigningOrder", "SigningOrderStrategyProtocol", "SigningOrderPatternMatcher", -] \ No newline at end of file + "SigningOrder", + "SigningOrderStrategyProtocol", + "SigningOrderPatternMatcher", +] diff --git a/signoffs/core/signing_order/signoff_pattern.py b/signoffs/core/signing_order/signoff_pattern.py index 6aec044..a7c914b 100644 --- a/signoffs/core/signing_order/signoff_pattern.py +++ b/signoffs/core/signing_order/signoff_pattern.py @@ -209,4 +209,4 @@ class InParallel(PatternSet): "InSeries", "OneOrMore", "Optional", -] \ No newline at end of file +] diff --git a/signoffs/core/signoffs.py b/signoffs/core/signoffs.py index 8f1d59a..63eac4b 100644 --- a/signoffs/core/signoffs.py +++ b/signoffs/core/signoffs.py @@ -161,7 +161,7 @@ def revoke(self, signoff, user, reason="", **kwargs): class SignoffLogic(DefaultSignoffBusinessLogic): - """ Public API: Alias for `DefaultSignoffBusinessLogic """ + """Public API: Alias for `DefaultSignoffBusinessLogic""" class AbstractSignoff: @@ -480,6 +480,11 @@ class BaseSignoff(AbstractSignoff): label = "I consent" -__all__ =[ - 'sign_signoff', 'revoke_signoff', 'AbstractSignoff', 'BaseSignoff', 'DefaultSignoffBusinessLogic', 'SignoffLogic' -] \ No newline at end of file +__all__ = [ + "sign_signoff", + "revoke_signoff", + "AbstractSignoff", + "BaseSignoff", + "DefaultSignoffBusinessLogic", + "SignoffLogic", +] diff --git a/signoffs/core/urls/__init__.py b/signoffs/core/urls/__init__.py index 226b087..e4d00eb 100644 --- a/signoffs/core/urls/__init__.py +++ b/signoffs/core/urls/__init__.py @@ -1,8 +1,2 @@ -from .signoffs import ( - SignoffInstanceUrls, - SignoffUrlsManager, -) -from .approvals import ( - ApprovalInstanceUrls, - ApprovalUrlsManager, -) +from .approvals import ApprovalInstanceUrls, ApprovalUrlsManager +from .signoffs import SignoffInstanceUrls, SignoffUrlsManager diff --git a/signoffs/core/urls/approvals.py b/signoffs/core/urls/approvals.py index e0eda41..6cb522c 100644 --- a/signoffs/core/urls/approvals.py +++ b/signoffs/core/urls/approvals.py @@ -36,7 +36,6 @@ def get_revoke_url(self, args=None, kwargs=None): ) - class ApprovalUrlsManager(service(ApprovalInstanceUrls)): """ A descriptor class that "injects" a ApprovalInstanceUrls instance into a Approval instance. diff --git a/signoffs/core/utils.py b/signoffs/core/utils.py index 4fd9f2d..3e77b56 100644 --- a/signoffs/core/utils.py +++ b/signoffs/core/utils.py @@ -267,4 +267,4 @@ def class_service(service_class, **kwargs): "ServiceDescriptor", "class_service", "ClassServiceDescriptor", -] \ No newline at end of file +] diff --git a/signoffs/registry.py b/signoffs/registry.py index a11a6e1..81e1c1f 100644 --- a/signoffs/registry.py +++ b/signoffs/registry.py @@ -47,6 +47,7 @@ def object_type(self): signoffs = SignoffTypes() """Singleton - the Signoff Types registry. `(see persisting_theory.Registry)`""" + def get_signoff_type(signoff_id_or_type): """ Return a registered Signoff Type or raise ImproperlyConfigured if no such type was registered. @@ -132,6 +133,4 @@ def decorator(cls): return decorator -__all__ = [ - "signoffs", "approvals", "register" -] \ No newline at end of file +__all__ = ["signoffs", "approvals", "register"] diff --git a/signoffs/signing_order.py b/signoffs/signing_order.py index bf169f5..5431e7d 100644 --- a/signoffs/signing_order.py +++ b/signoffs/signing_order.py @@ -4,7 +4,8 @@ isort:skip_file """ from signoffs.core.signing_order.signing_order import ( - SigningOrderStrategyProtocol, SigningOrder + SigningOrderStrategyProtocol, + SigningOrder, ) from signoffs.core.signing_order.signoff_pattern import ( AnyOneOf, diff --git a/tasks/deps.py b/tasks/deps.py index c8bd909..eafc8a9 100644 --- a/tasks/deps.py +++ b/tasks/deps.py @@ -12,7 +12,7 @@ def compile(c, upgrade=False, extras=(), output_file="requirements.txt", options @task def compile_dev(c, upgrade=False, extras=(), output_file="requirements_dev.txt", options=''): """ pip-compile Dev requirements """ - compile(c, upgrade=upgrade, extras=extras, output_file=output_file, options='--all-extras '+options) + compile(c, upgrade=upgrade, extras=extras, output_file=output_file, options='--all-extras ' + options) @task diff --git a/tests/test_app/models.py b/tests/test_app/models.py index be9ae47..68590ad 100644 --- a/tests/test_app/models.py +++ b/tests/test_app/models.py @@ -5,7 +5,6 @@ from django.db import models from django_fsm import FSMField, transition -from signoffs.process import FsmApprovalsProcess, user_can_revoke_approval from signoffs.approvals import ApprovalSignoff, SimpleApproval from signoffs.approvals import signing_order as so from signoffs.models import ( @@ -17,6 +16,7 @@ SignoffSet, Stamp, ) +from signoffs.process import FsmApprovalsProcess, user_can_revoke_approval from signoffs.registry import register from signoffs.signoffs import SignoffRenderer, SimpleSignoff diff --git a/tox.ini b/tox.ini index b4ac18b..8ac2015 100644 --- a/tox.ini +++ b/tox.ini @@ -74,5 +74,6 @@ per-file-ignores = signoffs/forms.py: F401 signoffs/models.py: F401 signoffs/process.py: F401 + signoffs/signing_order.py: F401 signoffs/signoffs.py: F401 signoffs/core/utils.py: C901