docsig 0.55.0__tar.gz → 0.56.0__tar.gz

{docsig-0.55.0 → docsig-0.56.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: docsig
-Version: 0.55.0
+Version: 0.56.0
 Summary: Check signature params for proper documentation
 Home-page: https://pypi.org/project/docsig/
 License: MIT
@@ -152,14 +152,14 @@ Options can also be configured with the pyproject.toml file
     check-overridden = false
     check-protected = false
     disable = [
-        "E101",
-        "E102",
-        "E103",
+        "SIG101",
+        "SIG102",
+        "SIG402",
     ]
     target = [
-        "E102",
-        "E103",
-        "E104",
+        "SIG202",
+        "SIG203",
+        "SIG201",
     ]
 
 API
@@ -196,7 +196,7 @@ API
     ... """
     >>> docsig(string=string, no_ansi=True)
     2 in function
-        E102: includes parameters that do not exist (params-do-not-exist)
+        SIG202: includes parameters that do not exist (params-do-not-exist)
     1
 
 A full list of checks can be found `here <https://docsig.readthedocs.io/en/latest/usage/messages.html>`__
@@ -204,6 +204,9 @@ A full list of checks can be found `here <https://docsig.readthedocs.io/en/lates
 Message Control
 ***************
 
+If you have been using ``docsig`` prior to ``v0.56.0``, please see
+`updated messages <https://docsig.readthedocs.io/en/latest/deprecated/messages.html>`_
+
 `Documentation on message control <https://docsig.readthedocs.io/en/latest/usage/message-control.html>`_
 
 Classes
@@ -222,7 +225,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.55.0
+        rev: v0.56.0
         hooks:
           - id: docsig
             args:

{docsig-0.55.0 → docsig-0.56.0}/README.rst

@@ -124,14 +124,14 @@ Options can also be configured with the pyproject.toml file
     check-overridden = false
     check-protected = false
     disable = [
-        "E101",
-        "E102",
-        "E103",
+        "SIG101",
+        "SIG102",
+        "SIG402",
     ]
     target = [
-        "E102",
-        "E103",
-        "E104",
+        "SIG202",
+        "SIG203",
+        "SIG201",
     ]
 
 API
@@ -168,7 +168,7 @@ API
     ... """
     >>> docsig(string=string, no_ansi=True)
     2 in function
-        E102: includes parameters that do not exist (params-do-not-exist)
+        SIG202: includes parameters that do not exist (params-do-not-exist)
     1
 
 A full list of checks can be found `here <https://docsig.readthedocs.io/en/latest/usage/messages.html>`__
@@ -176,6 +176,9 @@ A full list of checks can be found `here <https://docsig.readthedocs.io/en/lates
 Message Control
 ***************
 
+If you have been using ``docsig`` prior to ``v0.56.0``, please see
+`updated messages <https://docsig.readthedocs.io/en/latest/deprecated/messages.html>`_
+
 `Documentation on message control <https://docsig.readthedocs.io/en/latest/usage/message-control.html>`_
 
 Classes
@@ -194,7 +197,7 @@ It can be added to your .pre-commit-config.yaml as follows:
 
     repos:
       - repo: https://github.com/jshwi/docsig
-        rev: v0.55.0
+        rev: v0.56.0
         hooks:
           - id: docsig
             args:

{docsig-0.55.0 → docsig-0.56.0}/docsig/_report.py

@@ -80,24 +80,24 @@ class Failure(_t.List[str]):
             if not comment.isvalid:
                 if comment.ismodule:
                     # unknown-module-directive
-                    self._add(_E[201], directive=comment.kind)
+                    self._add(_E[1], directive=comment.kind)
                 else:
                     # unknown-inline-directive
-                    self._add(_E[202], directive=comment.kind)
+                    self._add(_E[2], directive=comment.kind)
             else:
                 for rule in comment:
                     if not rule.isknown:
                         if comment.ismodule:
                             # unknown-module-directive-option
                             self._add(
-                                _E[203],
+                                _E[3],
                                 directive=comment.kind,
                                 option=rule.description,
                             )
                         else:
                             # unknown-inline-directive-option
                             self._add(
-                                _E[204],
+                                _E[4],
                                 directive=comment.kind,
                                 option=rule.description,
                             )
@@ -105,10 +105,10 @@ class Failure(_t.List[str]):
     def _sig1xx_missing(self) -> None:
         if not self._func.isinit:
             # function-doc-missing
-            self._add(_E[113])
+            self._add(_E[101])
         else:
             # class-doc-missing
-            self._add(_E[114])
+            self._add(_E[102])
 
     def _sig2xx_signature(self) -> None:
         if self._func.docstring.args.duplicated:
@@ -120,7 +120,7 @@ class Failure(_t.List[str]):
                     self._func.docstring.args.pop(count)
 
             # duplicate-params-found
-            self._add(_E[106])
+            self._add(_E[201])
         # there are non-existing params in the docstring
         elif len(self._func.docstring.args) > len(self._func.signature.args):
             # pop the parameters that do not exist so that they are
@@ -133,7 +133,7 @@ class Failure(_t.List[str]):
                 if count > len(self._func.signature.args):
                     self._func.docstring.args.pop(count - 1)
             # params-do-not-exist
-            self._add(_E[102])
+            self._add(_E[202])
         # there are more args in sig than doc, so doc params missing
         elif len(self._func.signature.args) > len(self._func.docstring.args):
             # append the parameters that are missing so that they are
@@ -148,33 +148,33 @@ class Failure(_t.List[str]):
                         _Param(arg.kind, arg.name, _VALID_DESCRIPTION, 0)
                     )
             # params-missing
-            self._add(_E[103])
+            self._add(_E[203])
 
     def _sig3xx_description(self, doc: _Param) -> None:
         if doc.description is None:
-            self._add(_E[117])
+            self._add(_E[301])
         elif doc.description is not None and not doc.description.startswith(
             " "
         ):
             # syntax-error-in-description
-            self._add(_E[115])
+            self._add(_E[302])
         # if the parameter does not have a name, but exists, then it
         # must be incorrectly documented
         elif doc.name == _UNNAMED:
             # param-incorrectly-documented
-            self._add(_E[107])
+            self._add(_E[303])
 
     def _sig4xx_parameters(self, doc: _Param, sig: _Param) -> None:
         if doc.indent > 0:
             # incorrect-indent
-            self._add(_E[116])
+            self._add(_E[401])
         elif doc != sig:
             if (
                 sig.name in self._func.docstring.args.names
                 or doc.name in self.func.signature.args.names
             ):
                 # params-out-of-order
-                self._add(_E[101])
+                self._add(_E[402])
             elif (
                 doc.name != _UNNAMED
                 and sig.name is not None
@@ -182,10 +182,10 @@ class Failure(_t.List[str]):
             ):
                 if _almost_equal(sig.name, doc.name, _MIN_MATCH, _MAX_MATCH):
                     # spelling-error
-                    self._add(_E[112])
+                    self._add(_E[403])
                 else:
                     # param-not-equal-to-arg
-                    self._add(_E[110])
+                    self._add(_E[404])
 
     def _sig5xx_returns(self) -> None:
         if not self._func.isinit and not (
@@ -194,28 +194,28 @@ class Failure(_t.List[str]):
             # no types, cannot know either way
             if self._func.signature.rettype == _RetType.UNTYPED:
                 # confirm-return-needed
-                self._add(_E[109], hint=True)
+                self._add(_E[501], hint=True)
             # return type is none, so no return should be documented
             elif self._func.docstring.returns:
                 if self._func.signature.rettype == _RetType.NONE:
                     # return-documented-for-none
-                    self._add(_E[104])
+                    self._add(_E[502])
             # return type is some, so return should be documented
             elif self._func.signature.returns:
                 # return-missing
                 self._add(
-                    _E[105],
+                    _E[503],
                     hint=_has_bad_return(str(self._func.docstring.string)),
                 )
         elif self._func.docstring.returns:
             # method is init, so no return should be documented
             if self._func.isinit:
                 # class-return-documented
-                self._add(_E[111], hint=True)
+                self._add(_E[504], hint=True)
             # method is property and not set to document property
             elif self._func.isproperty and not self._check_property_returns:
                 # return-documented-for-property
-                self._add(_E[108], hint=True)
+                self._add(_E[505], hint=True)
 
     @property
     def func(self) -> _Function:

{docsig-0.55.0 → docsig-0.56.0}/docsig/_version.py

@@ -8,4 +8,4 @@ Allows for access to the version internally without cyclic imports
 caused by accessing it through __init__.
 """
 
-__version__ = "0.55.0"
+__version__ = "0.56.0"

{docsig-0.55.0 → docsig-0.56.0}/docsig/messages.py

@@ -6,12 +6,13 @@ docsig.messages
 from __future__ import annotations
 
 import typing as _t
+from warnings import warn as _warn
 
 #: Error code for unknown errors.
-UNKNOWN = "E000"
+UNKNOWN = "SIG000"
 
 #: Default template to format message strings.
-TEMPLATE = "{code}: {description} ({symbolic})"
+TEMPLATE = "{ref}: {description} ({symbolic})"
 
 
 class Message(_t.NamedTuple):
@@ -39,7 +40,7 @@ class Message(_t.NamedTuple):
         This might exist due to a typo or an attempt to retrieve an
         error that does not exist.
         """
-        return self.code != UNKNOWN
+        return self.ref != UNKNOWN
 
     def fstring(self, template: str) -> str:
         """Return message values as a string.
@@ -48,7 +49,7 @@ class Message(_t.NamedTuple):
         :return: Formatted string.
         """
         return template.format(
-            code=self.code,
+            ref=self.ref,
             description=self.description,
             symbolic=self.symbolic,
         )
@@ -68,7 +69,18 @@ class MessageMap(_t.Dict[int, Message]):
         :return: Message if valid ref else an unknown message type.
         """
         for value in self.values():
-            if ref in (value.ref, value.code, value.symbolic):
+            if ref == value.code:
+                _warn(
+                    "Exxx errors are deprecated and might not be supported in "
+                    "a future version, see "
+                    "https://docsig.readthedocs.io/en/latest/deprecated/"
+                    "messages.html",
+                    category=DeprecationWarning,
+                    stacklevel=6,
+                )
+                return value
+
+            if ref in (value.ref, value.symbolic):
                 return value
 
         return Message(UNKNOWN, UNKNOWN, ref)
@@ -84,144 +96,142 @@ class MessageMap(_t.Dict[int, Message]):
     @property
     def all(self) -> Messages:
         """Get all messages that aren't a config error."""
-        return Messages(
-            v for k, v in self.items() if str(k).startswith(str(1))
-        )
+        return Messages(v for k, v in self.items() if len(str(k)) > 1)
 
 
 # SIGxxx: Error
 E = MessageMap(
     {
         #: SIG0xx Config
-        201: Message(
+        1: Message(
             "SIG001",
             "E201",
             "unknown module comment directive '{directive}'",
             "unknown-module-directive",
         ),
-        202: Message(
+        2: Message(
             "SIG002",
             "E202",
             "unknown inline comment directive '{directive}'",
             "unknown-inline-directive",
         ),
-        203: Message(
+        3: Message(
             "SIG003",
             "E203",
             "unknown module comment option for {directive} '{option}'",
             "unknown-module-directive-option",
         ),
-        204: Message(
+        4: Message(
             "SIG004",
             "E204",
             "unknown inline comment option for {directive} '{option}'",
             "unknown-inline-directive-option",
         ),
         #: SIG1xx Missing
-        113: Message(
+        101: Message(
             "SIG101",
             "E113",
             "function is missing a docstring",
             "function-doc-missing",
         ),
-        114: Message(
+        102: Message(
             "SIG102",
             "E114",
             "class is missing a docstring",
             "class-doc-missing",
         ),
         #: SIG2xx Signature
-        106: Message(
+        201: Message(
             "SIG201",
             "E106",
             "duplicate parameters found",
             "duplicate-params-found",
         ),
-        102: Message(
+        202: Message(
             "SIG202",
             "E102",
             "includes parameters that do not exist",
             "params-do-not-exist",
         ),
-        103: Message(
+        203: Message(
             "SIG203",
             "E103",
             "parameters missing",
             "params-missing",
         ),
         #: SIG3xx Parameters
-        117: Message(
+        301: Message(
             "SIG301",
             "E117",
             "description missing from parameter",
             "description-missing",
         ),
-        115: Message(
+        302: Message(
             "SIG302",
             "E115",
             "syntax error in description",
             "syntax-error-in-description",
         ),
-        107: Message(
+        303: Message(
             "SIG303",
             "E107",
             "parameter appears to be incorrectly documented",
             "param-incorrectly-documented",
         ),
         #: SIG4xx Description
-        116: Message(
+        401: Message(
             "SIG401",
             "E116",
             "param not indented correctly",
             "incorrect-indent",
         ),
-        101: Message(
+        402: Message(
             "SIG402",
             "E101",
             "parameters out of order",
             "params-out-of-order",
         ),
-        112: Message(
+        403: Message(
             "SIG403",
             "E112",
             "spelling error found in documented parameter",
             "spelling-error",
         ),
-        110: Message(
+        404: Message(
             "SIG404",
             "E110",
             "documented parameter not equal to its respective argument",
             "param-not-equal-to-arg",
         ),
         #: SIG5xx Returns
-        109: Message(
+        501: Message(
             "SIG501",
             "E109",
             "cannot determine whether a return statement should exist",
             "confirm-return-needed",
             "annotate type to indicate whether return documentation needed",
         ),
-        104: Message(
+        502: Message(
             "SIG502",
             "E104",
             "return statement documented for None",
             "return-documented-for-none",
         ),
-        105: Message(
+        503: Message(
             "SIG503",
             "E105",
             "return missing from docstring",
             "return-missing",
             "it is possible a syntax error could be causing this",
         ),
-        111: Message(
+        504: Message(
             "SIG504",
             "E111",
             "return statement documented for class",
             "class-return-documented",
             "a class does not return a value during instantiation",
         ),
-        108: Message(
+        505: Message(
             "SIG505",
             "E108",
             "return statement documented for property",

{docsig-0.55.0 → docsig-0.56.0}/pyproject.toml

@@ -76,7 +76,7 @@ maintainers = [
 name = "docsig"
 readme = "README.rst"
 repository = "https://github.com/jshwi/docsig"
-version = "0.55.0"
+version = "0.56.0"
 
 [tool.poetry.dependencies]
 Sphinx = "^7.0.0"