Merge branch 'master' into hh/doc-improvement

Author: haraldh

.github/workflows/publish.yml

@@ -24,10 +24,10 @@ jobs:
         with:
           ref: ${{ inputs.tag && format('refs/tags/{0}', inputs.tag) || github.ref }}
           fetch-depth: 0
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v1
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: "3.12"
 
       - name: Install pypa/build
         run: >-

varlink/__init__.py

@@ -11,9 +11,6 @@
 - :class:`varlink.ThreadingServer` -- multi-threaded server for concurrent connections
 - :class:`varlink.ForkingServer` -- multi-process server (Unix/Linux only)
 
-All server classes live in the ``varlink`` package; import them from ``varlink``, not from
-``socketserver``.
-
 For client implementations use the :class:`varlink.Client` class.
 
 For installation and examples, see the GIT repository https://github.com/varlink/python

varlink/error.py

@@ -16,7 +16,7 @@ def default(self, o):
 
 
 class VarlinkError(Exception):
-    """The base class for varlink error exceptions.
+    """The base class for varlink errors.
 
     User-defined errors
     ~~~~~~~~~~~~~~~~~~~
@@ -26,12 +26,12 @@ class VarlinkError(Exception):
     keys to the base ``__init__``. The parameter names and types must match the
     ``.varlink`` definition manually; there is no automatic binding::
 
-        # Given:  error ActionFailed (field: string)  in the .varlink file
+        # Given:  error ActionFailed (field: string)  in an org.example.myinterface.varlink file
 
         class ActionFailed(VarlinkError):
             def __init__(self, reason):
                 VarlinkError.__init__(self, {
-                    "error": "com.example.ActionFailed",
+                    "error": "org.example.myinterface.ActionFailed",
                     "parameters": {"field": reason},
                 })
 

varlink/server.py

@@ -290,14 +290,14 @@ def _set_interface(self, filename, interface_class):
     def interface(self, filename):
         """Decorator that registers a class as the handler for a varlink interface.
 
-        :param filename: A varlink interface name (e.g. ``'com.example.service'``).
+        :param filename: A varlink interface name (e.g. ``'org.example.service'``).
             The file ``{filename}.varlink`` is loaded from the ``interface_dir`` given
             to the Service constructor. This must be an interface name or a file path,
             **not** a Python class or type.
 
         Example::
 
-            @service.interface('com.example.service')
+            @service.interface('org.example.service')
             class Example:
                 def Echo(self, message):
                     return {"message": message}
@@ -408,9 +408,9 @@ class Server(BaseServer):
         >>> class ServiceRequestHandler(varlink.RequestHandler):
         >>>    service = service
         >>>
-        >>> @service.interface('com.example.service')
+        >>> @service.interface('org.example.service')
         >>> class Example:
-        >>>    # com.example.service method implementation here …
+        >>>    # org.example.service method implementation here …
         >>>    pass
         >>>
         >>> server = varlink.ThreadingServer(sys.argv[1][10:], ServiceRequestHandler)

varlink/tests/test_scanner.py

@@ -87,7 +87,7 @@ def test_complex() -> None:
 invalid_interfacenames = [
     "interface .a.b.c\nmethod F()->()",
     "interface com.-example.leadinghyphen\nmethod F()->()",
-    "interface com.example-.danglinghyphen-\nmethod F()->()",
+    "interface org.example-.danglinghyphen-\nmethod F()->()",
     "interface co9.example.number-toplevel\nmethod F()->()",
     "interface 1om.example.number-toplevel\nmethod F()->()",
     "interface ab\nmethod F()->()",
@@ -118,8 +118,8 @@ def test_interfacename_invalid(description) -> None:
     "interface a.1\nmethod F()->()",
     "interface a.0.0\nmethod F()->()",
     "interface org.varlink.service\nmethod F()->()",
-    "interface com.example.0example\nmethod F()->()",
-    "interface com.example.example-dash\nmethod F()->()",
+    "interface org.example.0example\nmethod F()->()",
+    "interface org.example.example-dash\nmethod F()->()",
     "interface xn--lgbbat1ad8j.example.algeria\nmethod F()->()",
     "interface xn--c1yn36f.xn--c1yn36f.xn--c1yn36f\nmethod F()->()",
 ]