Update branding (#81)

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 UAVCAN Consortium
+Copyright (c) 2018 OpenCyphal
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

README.md

@@ -3,7 +3,7 @@
 [![Build status](https://ci.appveyor.com/api/projects/status/lurx5gihhcl9wq1w/branch/master?svg=true)](https://ci.appveyor.com/project/Zubax/pydsdl/branch/master)
 [![Documentation Status](https://readthedocs.org/projects/pydsdl/badge/?version=latest)](https://pydsdl.readthedocs.io/en/latest/?badge=latest)
 [![PyPI - Downloads](https://img.shields.io/pypi/dm/pydsdl)](https://pypi.org/project/pydsdl/)
-[![Forum](https://img.shields.io/discourse/https/forum.uavcan.org/users.svg)](https://forum.uavcan.org)
+[![Forum](https://img.shields.io/discourse/https/forum.opencyphal.org/users.svg)](https://forum.opencyphal.org)
 
 PyDSDL is a [Cyphal](https://opencyphal.org) DSDL compiler front-end implemented in Python.
 It accepts a DSDL namespace at the input and produces a well-annotated abstract syntax tree (AST) at the output,

appveyor.yml

@@ -67,7 +67,7 @@ for:
       # MS Windows test.
       - cmd: nox --forcecolor --non-interactive --error-on-missing-interpreters --session test lint
       # Shared test for all platforms.
-      - git clone https://github.com/UAVCAN/public_regulated_data_types .dsdl-test
+      - git clone https://github.com/OpenCyphal/public_regulated_data_types .dsdl-test
       - python -c "import pydsdl; pydsdl.read_namespace('.dsdl-test/uavcan', [])"
 
   # DEPLOYMENT PIPELINE
@@ -85,7 +85,7 @@ for:
       # Configure git credentials.
       - echo "https://${GIT_TOKEN}:[email protected]" > ~/.git-credentials
       - git config --global credential.helper store
-      - git config --global user.email "devnull@uavcan.org"
+      - git config --global user.email "devnull@opencyphal.org"
       - git config --global user.name  "Release Automation"
       # Tag and publish this release. Push the tag after the release is out in case it could not be published.
       - 'git tag $(python3 -c "import pydsdl; print(pydsdl.__version__)")'

docs/conf.py

@@ -1,13 +1,13 @@
-# Copyright (c) 2020 UAVCAN Consortium
+# Copyright (c) 2020 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 import sys
 import pathlib
 import datetime
 
 
-GITHUB_USER_REPO = "UAVCAN", "pydsdl"
+GITHUB_USER_REPO = "OpenCyphal", "pydsdl"
 
 DESCRIPTION = "A Cyphal DSDL compiler front-end in Python"
 
@@ -23,13 +23,13 @@
 
 EXTERNAL_LINKS = {
     "OpenCyphal homepage": "https://opencyphal.org/",
-    "Support forum": "https://forum.uavcan.org/",
+    "Support forum": "https://forum.opencyphal.org/",
 }
 
 project = "PyDSDL"
+author = "OpenCyphal"
 # noinspection PyShadowingBuiltins
-copyright = str(datetime.datetime.now().year) + ", UAVCAN Development Team"
-author = "UAVCAN Development Team"
+copyright = str(datetime.datetime.now().year) + ", " + author
 
 version = ".".join(map(str, pydsdl.__version_info__))
 release = pydsdl.__version__  # The full version, including alpha/beta/rc tags

docs/index.rst

@@ -6,7 +6,7 @@ It accepts a DSDL namespace at the input and produces a well-annotated abstract
 evaluating all constant expressions in the process.
 All DSDL features defined in the Cyphal Specification are supported.
 
-If you have questions, please bring them to the `support forum <https://forum.uavcan.org/>`_.
+If you have questions, please bring them to the `support forum <https://forum.opencyphal.org/>`_.
 
 Contributors, please read the :ref:`dev`!
 

docs/ref_fixer_hack.py

@@ -3,8 +3,8 @@
 
 I've constructed this Sphinx extension as a quick and dirty "solution" to the problem of broken cross-linking.
 
-The problem is that Autodoc fails to realize that an entity, say, pyuavcan.transport._session.InputSession is
-exposed to the user as pyuavcan.transport.InputSession, and that the original name is not a part of the API
+The problem is that Autodoc fails to realize that an entity, say, pycyphal.transport._session.InputSession is
+exposed to the user as pycyphal.transport.InputSession, and that the original name is not a part of the API
 and it shouldn't even be mentioned in the documentation at all. I've described this problem in this Sphinx issue
 at https://github.com/sphinx-doc/sphinx/issues/6574. Since the original name is not exported, Autodoc can't find
 it in the output and generates no link at all, requiring the user to search manually instead of just clicking on
@@ -24,39 +24,41 @@
 import docutils.nodes
 
 
-_ACCEPTANCE_PATTERN = r'.*([a-zA-Z][a-zA-Z0-9_]*\.)+_[a-zA-Z0-9_]*\..+'
-_REFTYPES = 'class', 'meth', 'func'
+_ACCEPTANCE_PATTERN = r".*([a-zA-Z][a-zA-Z0-9_]*\.)+_[a-zA-Z0-9_]*\..+"
+_REFTYPES = "class", "meth", "func"
 
 _replacements_made: typing.List[typing.Tuple[str, str]] = []
 
 
-def missing_reference(app:      sphinx.application.Sphinx,
-                      _env:     sphinx.environment.BuildEnvironment,
-                      node:     docutils.nodes.Element,
-                      contnode: docutils.nodes.Node) -> typing.Optional[docutils.nodes.Node]:
-    old_reftarget = node['reftarget']
-    if node['reftype'] in _REFTYPES and re.match(_ACCEPTANCE_PATTERN, old_reftarget):
-        new_reftarget = re.sub(r'\._[a-zA-Z0-9_]*', '', old_reftarget)
+def missing_reference(
+    app: sphinx.application.Sphinx,
+    _env: sphinx.environment.BuildEnvironment,
+    node: docutils.nodes.Element,
+    contnode: docutils.nodes.Node,
+) -> typing.Optional[docutils.nodes.Node]:
+    old_reftarget = node["reftarget"]
+    if node["reftype"] in _REFTYPES and re.match(_ACCEPTANCE_PATTERN, old_reftarget):
+        new_reftarget = re.sub(r"\._[a-zA-Z0-9_]*", "", old_reftarget)
         if new_reftarget != old_reftarget:
             _replacements_made.append((old_reftarget, new_reftarget))
             attrs = contnode.attributes if isinstance(contnode, docutils.nodes.Element) else {}
             try:
-                old_refdoc = node['refdoc']
+                old_refdoc = node["refdoc"]
             except KeyError:
                 return None
-            new_refdoc = old_refdoc.rsplit(os.path.sep, 1)[0] + os.path.sep + new_reftarget.rsplit('.', 1)[0]
-            return sphinx.util.nodes.make_refnode(app.builder,
-                                                  old_refdoc,
-                                                  new_refdoc,
-                                                  node.get('refid', new_reftarget),
-                                                  docutils.nodes.literal(new_reftarget, new_reftarget, **attrs),
-                                                  new_reftarget)
+            new_refdoc = old_refdoc.rsplit(os.path.sep, 1)[0] + os.path.sep + new_reftarget.rsplit(".", 1)[0]
+            return sphinx.util.nodes.make_refnode(
+                app.builder,
+                old_refdoc,
+                new_refdoc,
+                node.get("refid", new_reftarget),
+                docutils.nodes.literal(new_reftarget, new_reftarget, **attrs),
+                new_reftarget,
+            )
     return None
 
 
-def doctree_resolved(_app:     sphinx.application.Sphinx,
-                     doctree:  docutils.nodes.document,
-                     _docname: str) -> None:
+def doctree_resolved(_app: sphinx.application.Sphinx, doctree: docutils.nodes.document, _docname: str) -> None:
     def predicate(n: docutils.nodes.Node) -> bool:
         if isinstance(n, docutils.nodes.FixedTextElement):
             is_text_primitive = len(n.children) == 1 and isinstance(n.children[0], docutils.nodes.Text)
@@ -65,22 +67,20 @@ def predicate(n: docutils.nodes.Node) -> bool:
         return False
 
     def substitute_once(text: str) -> str:
-        out = re.sub(r'\._[a-zA-Z0-9_]*', '', text)
+        out = re.sub(r"\._[a-zA-Z0-9_]*", "", text)
         _replacements_made.append((text, out))
         return out
 
     # The objective here is to replace all references to hidden objects with their exported aliases.
-    # For example: pyuavcan.presentation._typed_session._publisher.Publisher --> pyuavcan.presentation.Publisher
+    # For example: pycyphal.presentation._typed_session._publisher.Publisher --> pycyphal.presentation.Publisher
     for node in doctree.traverse(predicate):
         assert isinstance(node, docutils.nodes.FixedTextElement)
-        node.children = [
-            docutils.nodes.Text(substitute_once(node.children[0].astext()))
-        ]
+        node.children = [docutils.nodes.Text(substitute_once(node.children[0].astext()))]
 
 
 def setup(app: sphinx.application.Sphinx):
-    app.connect('missing-reference', missing_reference)
-    app.connect('doctree-resolved', doctree_resolved)
+    app.connect("missing-reference", missing_reference)
+    app.connect("doctree-resolved", doctree_resolved)
     return {
-        'parallel_read_safe': True,
+        "parallel_read_safe": True,
     }

noxfile.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2021 UAVCAN Consortium
+# Copyright (c) 2021 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 # type: ignore
 
 import os

pydsdl/__init__.py

@@ -1,18 +1,18 @@
-# Copyright (c) 2018 UAVCAN Consortium
+# Copyright (c) 2018 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 # pylint: disable=wrong-import-position
 
 import os as _os
 import sys as _sys
 
-__version__ = "1.15.1"
+__version__ = "1.16.0"
 __version_info__ = tuple(map(int, __version__.split(".")[:3]))
 __license__ = "MIT"
-__author__ = "UAVCAN Consortium"
-__copyright__ = "Copyright (c) 2018 UAVCAN Consortium"
-__email__ = "consortium@uavcan.org"
+__author__ = "OpenCyphal"
+__copyright__ = "Copyright (c) 2018 OpenCyphal"
+__email__ = "maintainers@opencyphal.org"
 
 # Our unorthodox approach to dependency management requires us to apply certain workarounds.
 # Here, the objective is to allow our library to import stuff from its third-party dependency directory,

pydsdl/_bit_length_set/__init__.py

@@ -1,5 +1,5 @@
-# Copyright (c) 2021 UAVCAN Consortium
+# Copyright (c) 2021 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 from ._bit_length_set import BitLengthSet as BitLengthSet

pydsdl/_bit_length_set/_bit_length_set.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2018 UAVCAN Consortium
+# Copyright (c) 2018 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 import typing
 import warnings
@@ -14,7 +14,7 @@ class BitLengthSet:
 
     Most of the methods are evaluated analytically in nearly constant time rather than numerically.
     This is critical for complex layouts where numerical methods break due to combinatorial explosion and/or memory
-    limits (see this discussed in https://github.com/UAVCAN/pydsdl/issues/23).
+    limits (see this discussed in https://github.com/OpenCyphal/pydsdl/issues/23).
     There are several methods that trigger numerical expansion of the solution;
     due to the aforementioned combinatorial difficulties, they may be effectively incomputable in reasonable time,
     so production systems should not rely on them.

pydsdl/_bit_length_set/_symbolic.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2021 UAVCAN Consortium
+# Copyright (c) 2021 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 import os
 import abc

pydsdl/_bit_length_set/_symbolic_test.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2021 UAVCAN Consortium
+# Copyright (c) 2021 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 import typing
 import random

pydsdl/_data_schema_builder.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2018 UAVCAN Consortium
+# Copyright (c) 2018 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 from typing import List, Optional
 from . import _error

pydsdl/_data_type_builder.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2018 UAVCAN Consortium
+# Copyright (c) 2018 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 from typing import Optional, Callable, Iterable
 import logging
@@ -198,7 +198,7 @@ def resolve_versioned_data_type(self, name: str, version: _serializable.Version)
         del name
         found = list(filter(lambda d: d.full_name == full_name and d.version == version, self._lookup_definitions))
         if not found:
-            # Play Sherlock to help the user with mistakes like https://forum.uavcan.org/t/dsdl-compilation-error/904/2
+            # Play Sherlock to help the user with mistakes like https://forum.opencyphal.org/t/904/2
             requested_ns = full_name.split(_serializable.CompositeType.NAME_COMPONENT_SEPARATOR)[0]
             lookup_nss = set(x.root_namespace for x in self._lookup_definitions)
             subroot_ns = self._definition.name_components[1] if len(self._definition.name_components) > 2 else None

pydsdl/_dsdl_definition.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2018 UAVCAN Consortium
+# Copyright (c) 2018 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 import os
 import time
@@ -54,7 +54,7 @@ def __init__(self, file_path: Path, root_namespace_path: Path):
 
         relative_directory, basename = [str(x) for x in os.path.split(relative_path)]  # type: str, str
 
-        # Parsing the basename, e.g., 434.GetTransportStatistics.0.1.uavcan
+        # Parsing the basename, e.g., 434.GetTransportStatistics.0.1.dsdl
         basename_components = basename.split(".")[:-1]
         str_fixed_port_id: Optional[str] = None
         if len(basename_components) == 4:
@@ -72,7 +72,7 @@ def __init__(self, file_path: Path, root_namespace_path: Path):
                 raise FileNameFormatError(
                     "Not a valid fixed port-ID: %s. "
                     "Namespaces are defined as directories; putting the namespace name in the file name will not work. "
-                    'For example: "foo/Bar.1.0.uavcan" is OK (where "foo" is a directory); "foo.Bar.1.0.uavcan" is not.'
+                    'For example: "foo/Bar.1.0.dsdl" is OK (where "foo" is a directory); "foo.Bar.1.0.dsdl" is not.'
                     % str_fixed_port_id,
                     path=self._file_path,
                 ) from None

pydsdl/_error.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2018 UAVCAN Consortium
+# Copyright (c) 2018 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 # pylint: disable=broad-except
 
@@ -57,7 +57,7 @@ def __str__(self) -> str:
         Nicely formats an error string in the typical error format ``[file:[line:]]description``.
         Example::
 
-            uavcan/internet/udp/500.HandleIncomingPacket.1.0.uavcan:33: Error such and such
+            uavcan/internet/udp/500.HandleIncomingPacket.1.0.dsdl:33: Error such and such
         """
         if self.path and self.line:
             return "%s:%d: %s" % (self.path.as_posix(), self.line, self.text)
@@ -85,8 +85,9 @@ def __init__(
         culprit: typing.Optional[Exception] = None,
     ):
         if culprit is not None:
-            report_text = "PLEASE REPORT AT https://github.com/UAVCAN/pydsdl/issues/new?title=" + urllib.parse.quote(
-                repr(culprit)
+            report_text = (
+                "PLEASE REPORT AT https://github.com/OpenCyphal/pydsdl/issues/new?title="
+                + urllib.parse.quote(repr(culprit))
             )
             if text:
                 text = text + " " + report_text
@@ -115,16 +116,16 @@ def _unittest_error() -> None:
         assert repr(ex) == "FrontendError: 'Hello world!'"
 
     try:
-        raise FrontendError("Hello world!", path=Path("path/to/file.uavcan"), line=123)
+        raise FrontendError("Hello world!", path=Path("path/to/file.dsdl"), line=123)
     except Exception as ex:
-        assert str(ex) == "path/to/file.uavcan:123: Hello world!"
-        assert repr(ex) == "FrontendError: 'path/to/file.uavcan:123: Hello world!'"
+        assert str(ex) == "path/to/file.dsdl:123: Hello world!"
+        assert repr(ex) == "FrontendError: 'path/to/file.dsdl:123: Hello world!'"
 
     try:
-        raise FrontendError("Hello world!", path=Path("path/to/file.uavcan"))
+        raise FrontendError("Hello world!", path=Path("path/to/file.dsdl"))
     except Exception as ex:
-        assert str(ex) == "path/to/file.uavcan: Hello world!"
-        assert repr(ex) == "FrontendError: 'path/to/file.uavcan: Hello world!'"
+        assert str(ex) == "path/to/file.dsdl: Hello world!"
+        assert repr(ex) == "FrontendError: 'path/to/file.dsdl: Hello world!'"
 
 
 def _unittest_internal_error_github_reporting() -> None:
@@ -155,7 +156,7 @@ def _unittest_internal_error_github_reporting() -> None:
         #   Exception('ERROR TEXT')
         assert str(ex).startswith(
             "FILE_PATH:42: BASE TEXT "
-            "PLEASE REPORT AT https://github.com/UAVCAN/pydsdl/issues/new?title=Exception%28%27ERROR%20TEXT%27"
+            "PLEASE REPORT AT https://github.com/OpenCyphal/pydsdl/issues/new?title=Exception%28%27ERROR%20TEXT%27"
         )
 
     try:

pydsdl/_expression/__init__.py

@@ -1,6 +1,6 @@
-# Copyright (c) 2018 UAVCAN Consortium
+# Copyright (c) 2018 OpenCyphal
 # This software is distributed under the terms of the MIT License.
-# Author: Pavel Kirienko <pavel@uavcan.org>
+# Author: Pavel Kirienko <pavel@opencyphal.org>
 
 from ._any import Any as Any
 from ._any import UndefinedOperatorError as UndefinedOperatorError