Allow optional "/" in Doctype syntax (#50)

Now it's allowed to write instead of "*/*/*" the syntax "/*/*/*"
and all variations of it. It's the same, but helps to avoid
accidental errors

Author: tomschr

changelog.d/50.feature.rst

@@ -0,0 +1,2 @@
+Allow optional slash in Doctype syntax.
+Now it's allowed to write instead of ``"*/*/*"`` the syntax ``"/*/*/*"`` and all variations of it. It's the same, but helps to avoid accidental errors.

docs/source/reference/_autoapi/docbuild/models/doctype/Doctype.rst

@@ -11,6 +11,19 @@ docbuild.models.doctype.Doctype
 
    A "doctype" that comprises of a product, docset, lifecycle, and language.
 
+   The format has the following syntax:
+
+   .. code-block:: text
+
+      [/]?[PRODUCT]/[DOCSETS][@LIFECYCLES]/LANGS
+
+   The placeholders mean the following:
+
+   * ``PRODUCT``: a lowercase acronym of a SUSE product, e.g. ``sles``
+   * ``DOCSETS``: one or more docsets of the mentioned product, separated by comma
+   * ``LIFECYCLES``: one or more lifecycles, separated by comma or pipe
+   * ``LANGS``: one or more languages, separated by comma
+
    >>> doctype = Doctype.from_str("sles/15-SP6@supported/en-us,de-de")
    >>> doctype.product
    <Product.sles: 'sles'>
@@ -134,17 +147,6 @@ docbuild.models.doctype.Doctype
 
       Parse a string that adheres to the doctype format.
 
-      The format has the following syntax::
-
-          [PRODUCT]/[DOCSETS][@LIFECYCLES]/LANGS
-
-      Plural means you can have one or more items:
-
-      * ``PRODUCT``: a lowercase acronym of a SUSE product, e.g. ``sles``
-      * ``DOCSETS``: separated by comma
-      * ``LIFECYCLES``: separated by comma or pipe
-      * ``LANGS``: separated by comma
-
 
 
    .. py:method:: xpath() -> str

src/docbuild/models/doctype.py

@@ -15,6 +15,19 @@
 class Doctype(BaseModel):
     """A "doctype" that comprises of a product, docset, lifecycle, and language.
 
+    The format has the following syntax:
+
+    .. code-block:: text
+
+       [/]?[PRODUCT]/[DOCSETS][@LIFECYCLES]/LANGS
+
+    The placeholders mean the following:
+
+    * ``PRODUCT``: a lowercase acronym of a SUSE product, e.g. ``sles``
+    * ``DOCSETS``: one or more docsets of the mentioned product, separated by comma
+    * ``LIFECYCLES``: one or more lifecycles, separated by comma or pipe
+    * ``LANGS``: one or more languages, separated by comma
+
     >>> doctype = Doctype.from_str("sles/15-SP6@supported/en-us,de-de")
     >>> doctype.product
     <Product.sles: 'sles'>
@@ -80,7 +93,7 @@ class Doctype(BaseModel):
     # This leads to None in the result if that group isn't matched
     _DOCTYPE_REGEX: ClassVar[Pattern] = re.compile(
         r'^'  # start
-        r'(?:([^/@]+|\*))?'  # optional product (group 1)
+        r'(?:/?([^/@]+|\*))?'  # optional product (group 1)
         r'/(?:([^/@]+|\*))?'  # optional docset (group 2)
         r'(?:@([a-z]+(?:[,|][a-z]+)*))?'  # optional lifecycle (group 3)
         r'/(\*|[\w-]+(?:,[\w-]+)*)$',  # required langs (group 4)
@@ -198,19 +211,7 @@ def coerce_langs(cls, value: str | list[str | LanguageCode]) -> list[LanguageCod
 
     @classmethod
     def from_str(cls, doctype_str: str) -> Self:
-        """Parse a string that adheres to the doctype format.
-
-        The format has the following syntax::
-
-            [PRODUCT]/[DOCSETS][@LIFECYCLES]/LANGS
-
-        Plural means you can have one or more items:
-
-        * ``PRODUCT``: a lowercase acronym of a SUSE product, e.g. ``sles``
-        * ``DOCSETS``: separated by comma
-        * ``LIFECYCLES``: separated by comma or pipe
-        * ``LANGS``: separated by comma
-        """
+        """Parse a string that adheres to the doctype format."""
         match = cls._DOCTYPE_REGEX.match(doctype_str)
 
         if not match:

tests/models/test_doctype.py

@@ -84,6 +84,10 @@ def test_multiplestrings_langs_in_doctype():
             '//en-us',
             (Product.ALL, ['*'], LifecycleFlag.unknown, [LanguageCode('en-us')]),
         ),
+        (
+            '/*/*/en-us',
+            (Product.ALL, ['*'], LifecycleFlag.unknown, [LanguageCode('en-us')]),
+        ),
         (
             '*//en-us',
             (Product.ALL, ['*'], LifecycleFlag.unknown, [LanguageCode('en-us')]),
@@ -108,6 +112,18 @@ def test_multiplestrings_langs_in_doctype():
             'sles/*@beta/en-us',
             (Product.sles, ['*'], LifecycleFlag.beta, [LanguageCode('en-us')]),
         ),
+        (
+            '/sles/*@beta/en-us',
+            (Product.sles, ['*'], LifecycleFlag.beta, [LanguageCode('en-us')]),
+        ),
+        (
+            '/*/*@supported/*',
+            (Product.ALL, ['*'], LifecycleFlag.supported, [LanguageCode('*')]),
+        ),
+        (
+            '/*/*/*',
+            (Product.ALL, ['*'], LifecycleFlag.unknown, [LanguageCode('*')]),
+        ),
     ],
 )
 def test_valid_string_from_string(string, expected):