python-osc 1.8.0__tar.gz → 1.8.2__tar.gz

{python-osc-1.8.0 → python-osc-1.8.2}/MANIFEST.in

@@ -1,2 +1,3 @@
 include README.rst
 include LICENSE.txt
+include pythonosc/py.typed

python-osc-1.8.2/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.1
+Name: python-osc
+Version: 1.8.2
+Summary: Open Sound Control server and client implementations in pure Python
+Author-email: attwad <tmusoft@gmail.com>
+License: This is free and unencumbered software released into the public domain.
+        
+        Anyone is free to copy, modify, publish, use, compile, sell, or
+        distribute this software, either in source code form or as a compiled
+        binary, for any purpose, commercial or non-commercial, and by any
+        means.
+        
+        In jurisdictions that recognize copyright laws, the author or authors
+        of this software dedicate any and all copyright interest in the
+        software to the public domain. We make this dedication for the benefit
+        of the public at large and to the detriment of our heirs and
+        successors. We intend this dedication to be an overt act of
+        relinquishment in perpetuity of all present and future rights to this
+        software under copyright law.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+        IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+        OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+        ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+        OTHER DEALINGS IN THE SOFTWARE.
+        
+        For more information, please refer to <http://unlicense.org/>
+        
+Project-URL: Repository, https://github.com/attwad/python-osc
+Keywords: osc,sound,midi,music
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: Freely Distributable
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+
+==========
+python-osc
+==========
+
+Open Sound Control server and client implementations in **pure python**.
+
+.. image:: https://github.com/attwad/python-osc/actions/workflows/python-test.yml/badge.svg
+    :target: https://github.com/attwad/python-osc/actions/workflows/python-test.yml
+
+
+Current status
+==============
+
+This library was developed following the
+`OpenSoundControl Specification 1.0 <https://opensoundcontrol.stanford.edu/spec-1_0.html>`_
+and is currently in a stable state.
+
+Features
+========
+
+* UDP blocking/threading/forking/asyncio server implementations
+* UDP client
+* int, int64, float, string, double, MIDI, timestamps, blob, nil OSC arguments
+* simple OSC address<->callback matching system
+* extensive unit test coverage
+* basic client and server examples
+
+Documentation
+=============
+
+Available at https://python-osc.readthedocs.io/.
+
+Installation
+============
+
+python-osc is a pure python library that has no external dependencies,
+to install it just use pip (prefered):
+
+.. image:: https://img.shields.io/pypi/v/python-osc.svg
+    :target: https://pypi.python.org/pypi/python-osc
+
+.. code-block:: bash
+
+    $ pip install python-osc
+
+or from the raw sources for the development version:
+
+.. code-block:: bash
+
+    $ python setup.py test
+    $ python setup.py install
+
+Examples
+========
+
+Simple client
+-------------
+
+.. code-block:: python
+
+  """Small example OSC client
+
+  This program sends 10 random values between 0.0 and 1.0 to the /filter address,
+  waiting for 1 seconds between each value.
+  """
+  import argparse
+  import random
+  import time
+
+  from pythonosc import udp_client
+
+
+  if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--ip", default="127.0.0.1",
+        help="The ip of the OSC server")
+    parser.add_argument("--port", type=int, default=5005,
+        help="The port the OSC server is listening on")
+    args = parser.parse_args()
+
+    client = udp_client.SimpleUDPClient(args.ip, args.port)
+
+    for x in range(10):
+      client.send_message("/filter", random.random())
+      time.sleep(1)
+
+Simple server
+-------------
+
+.. code-block:: python
+
+  """Small example OSC server
+
+  This program listens to several addresses, and prints some information about
+  received packets.
+  """
+  import argparse
+  import math
+
+  from pythonosc.dispatcher import Dispatcher
+  from pythonosc import osc_server
+
+  def print_volume_handler(unused_addr, args, volume):
+    print("[{0}] ~ {1}".format(args[0], volume))
+
+  def print_compute_handler(unused_addr, args, volume):
+    try:
+      print("[{0}] ~ {1}".format(args[0], args[1](volume)))
+    except ValueError: pass
+
+  if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--ip",
+        default="127.0.0.1", help="The ip to listen on")
+    parser.add_argument("--port",
+        type=int, default=5005, help="The port to listen on")
+    args = parser.parse_args()
+
+    dispatcher = Dispatcher()
+    dispatcher.map("/filter", print)
+    dispatcher.map("/volume", print_volume_handler, "Volume")
+    dispatcher.map("/logvolume", print_compute_handler, "Log volume", math.log)
+
+    server = osc_server.ThreadingOSCUDPServer(
+        (args.ip, args.port), dispatcher)
+    print("Serving on {}".format(server.server_address))
+    server.serve_forever()
+
+Building bundles
+----------------
+
+.. code-block:: python
+
+    from pythonosc import osc_bundle_builder
+    from pythonosc import osc_message_builder
+
+    bundle = osc_bundle_builder.OscBundleBuilder(
+        osc_bundle_builder.IMMEDIATELY)
+    msg = osc_message_builder.OscMessageBuilder(address="/SYNC")
+    msg.add_arg(4.0)
+    # Add 4 messages in the bundle, each with more arguments.
+    bundle.add_content(msg.build())
+    msg.add_arg(2)
+    bundle.add_content(msg.build())
+    msg.add_arg("value")
+    bundle.add_content(msg.build())
+    msg.add_arg(b"\x01\x02\x03")
+    bundle.add_content(msg.build())
+
+    sub_bundle = bundle.build()
+    # Now add the same bundle inside itself.
+    bundle.add_content(sub_bundle)
+    # The bundle has 5 elements in total now.
+
+    bundle = bundle.build()
+    # You can now send it via a client as described in other examples.
+
+License?
+========
+Unlicensed, do what you want with it. (http://unlicense.org)

{python-osc-1.8.0 → python-osc-1.8.2}/README.rst

@@ -2,7 +2,7 @@
 python-osc
 ==========
 
-Open Sound Control server and client implementations in **pure python** (3.5+).
+Open Sound Control server and client implementations in **pure python**.
 
 .. image:: https://github.com/attwad/python-osc/actions/workflows/python-test.yml/badge.svg
     :target: https://github.com/attwad/python-osc/actions/workflows/python-test.yml
@@ -11,8 +11,8 @@ Open Sound Control server and client implementations in **pure python** (3.5+).
 Current status
 ==============
 
-This library was developped following the specifications at
-http://opensoundcontrol.org/spec-1_0
+This library was developed following the
+`OpenSoundControl Specification 1.0 <https://opensoundcontrol.stanford.edu/spec-1_0.html>`_
 and is currently in a stable state.
 
 Features
@@ -20,7 +20,7 @@ Features
 
 * UDP blocking/threading/forking/asyncio server implementations
 * UDP client
-* int, int64, float, string, double, MIDI, timestamps, blob OSC arguments
+* int, int64, float, string, double, MIDI, timestamps, blob, nil OSC arguments
 * simple OSC address<->callback matching system
 * extensive unit test coverage
 * basic client and server examples
@@ -97,7 +97,7 @@ Simple server
   import argparse
   import math
 
-  from pythonosc import dispatcher
+  from pythonosc.dispatcher import Dispatcher
   from pythonosc import osc_server
 
   def print_volume_handler(unused_addr, args, volume):
@@ -116,7 +116,7 @@ Simple server
         type=int, default=5005, help="The port to listen on")
     args = parser.parse_args()
 
-    dispatcher = dispatcher.Dispatcher()
+    dispatcher = Dispatcher()
     dispatcher.map("/filter", print)
     dispatcher.map("/volume", print_volume_handler, "Volume")
     dispatcher.map("/logvolume", print_compute_handler, "Log volume", math.log)

python-osc-1.8.2/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "python-osc"
+version="1.8.2"
+description="Open Sound Control server and client implementations in pure Python"
+readme="README.rst"
+requires-python=">=3.7"
+license = {file = "LICENSE.txt"}
+authors = [
+  {name = "attwad", email = "tmusoft@gmail.com"},
+]
+keywords = ["osc", "sound", "midi", "music"]
+classifiers=[
+    'Development Status :: 5 - Production/Stable',
+    'Intended Audience :: Developers',
+    'License :: Freely Distributable',
+    'Programming Language :: Python :: 3',
+    'Topic :: Multimedia :: Sound/Audio',
+    'Topic :: System :: Networking',
+]
+[project.urls]
+Repository = "https://github.com/attwad/python-osc"

python-osc-1.8.2/python_osc.egg-info/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.1
+Name: python-osc
+Version: 1.8.2
+Summary: Open Sound Control server and client implementations in pure Python
+Author-email: attwad <tmusoft@gmail.com>
+License: This is free and unencumbered software released into the public domain.
+        
+        Anyone is free to copy, modify, publish, use, compile, sell, or
+        distribute this software, either in source code form or as a compiled
+        binary, for any purpose, commercial or non-commercial, and by any
+        means.
+        
+        In jurisdictions that recognize copyright laws, the author or authors
+        of this software dedicate any and all copyright interest in the
+        software to the public domain. We make this dedication for the benefit
+        of the public at large and to the detriment of our heirs and
+        successors. We intend this dedication to be an overt act of
+        relinquishment in perpetuity of all present and future rights to this
+        software under copyright law.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+        IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+        OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+        ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+        OTHER DEALINGS IN THE SOFTWARE.
+        
+        For more information, please refer to <http://unlicense.org/>
+        
+Project-URL: Repository, https://github.com/attwad/python-osc
+Keywords: osc,sound,midi,music
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: Freely Distributable
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+
+==========
+python-osc
+==========
+
+Open Sound Control server and client implementations in **pure python**.
+
+.. image:: https://github.com/attwad/python-osc/actions/workflows/python-test.yml/badge.svg
+    :target: https://github.com/attwad/python-osc/actions/workflows/python-test.yml
+
+
+Current status
+==============
+
+This library was developed following the
+`OpenSoundControl Specification 1.0 <https://opensoundcontrol.stanford.edu/spec-1_0.html>`_
+and is currently in a stable state.
+
+Features
+========
+
+* UDP blocking/threading/forking/asyncio server implementations
+* UDP client
+* int, int64, float, string, double, MIDI, timestamps, blob, nil OSC arguments
+* simple OSC address<->callback matching system
+* extensive unit test coverage
+* basic client and server examples
+
+Documentation
+=============
+
+Available at https://python-osc.readthedocs.io/.
+
+Installation
+============
+
+python-osc is a pure python library that has no external dependencies,
+to install it just use pip (prefered):
+
+.. image:: https://img.shields.io/pypi/v/python-osc.svg
+    :target: https://pypi.python.org/pypi/python-osc
+
+.. code-block:: bash
+
+    $ pip install python-osc
+
+or from the raw sources for the development version:
+
+.. code-block:: bash
+
+    $ python setup.py test
+    $ python setup.py install
+
+Examples
+========
+
+Simple client
+-------------
+
+.. code-block:: python
+
+  """Small example OSC client
+
+  This program sends 10 random values between 0.0 and 1.0 to the /filter address,
+  waiting for 1 seconds between each value.
+  """
+  import argparse
+  import random
+  import time
+
+  from pythonosc import udp_client
+
+
+  if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--ip", default="127.0.0.1",
+        help="The ip of the OSC server")
+    parser.add_argument("--port", type=int, default=5005,
+        help="The port the OSC server is listening on")
+    args = parser.parse_args()
+
+    client = udp_client.SimpleUDPClient(args.ip, args.port)
+
+    for x in range(10):
+      client.send_message("/filter", random.random())
+      time.sleep(1)
+
+Simple server
+-------------
+
+.. code-block:: python
+
+  """Small example OSC server
+
+  This program listens to several addresses, and prints some information about
+  received packets.
+  """
+  import argparse
+  import math
+
+  from pythonosc.dispatcher import Dispatcher
+  from pythonosc import osc_server
+
+  def print_volume_handler(unused_addr, args, volume):
+    print("[{0}] ~ {1}".format(args[0], volume))
+
+  def print_compute_handler(unused_addr, args, volume):
+    try:
+      print("[{0}] ~ {1}".format(args[0], args[1](volume)))
+    except ValueError: pass
+
+  if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--ip",
+        default="127.0.0.1", help="The ip to listen on")
+    parser.add_argument("--port",
+        type=int, default=5005, help="The port to listen on")
+    args = parser.parse_args()
+
+    dispatcher = Dispatcher()
+    dispatcher.map("/filter", print)
+    dispatcher.map("/volume", print_volume_handler, "Volume")
+    dispatcher.map("/logvolume", print_compute_handler, "Log volume", math.log)
+
+    server = osc_server.ThreadingOSCUDPServer(
+        (args.ip, args.port), dispatcher)
+    print("Serving on {}".format(server.server_address))
+    server.serve_forever()
+
+Building bundles
+----------------
+
+.. code-block:: python
+
+    from pythonosc import osc_bundle_builder
+    from pythonosc import osc_message_builder
+
+    bundle = osc_bundle_builder.OscBundleBuilder(
+        osc_bundle_builder.IMMEDIATELY)
+    msg = osc_message_builder.OscMessageBuilder(address="/SYNC")
+    msg.add_arg(4.0)
+    # Add 4 messages in the bundle, each with more arguments.
+    bundle.add_content(msg.build())
+    msg.add_arg(2)
+    bundle.add_content(msg.build())
+    msg.add_arg("value")
+    bundle.add_content(msg.build())
+    msg.add_arg(b"\x01\x02\x03")
+    bundle.add_content(msg.build())
+
+    sub_bundle = bundle.build()
+    # Now add the same bundle inside itself.
+    bundle.add_content(sub_bundle)
+    # The bundle has 5 elements in total now.
+
+    bundle = bundle.build()
+    # You can now send it via a client as described in other examples.
+
+License?
+========
+Unlicensed, do what you want with it. (http://unlicense.org)

{python-osc-1.8.0 → python-osc-1.8.2}/python_osc.egg-info/SOURCES.txt

@@ -1,8 +1,8 @@
 LICENSE.txt
 MANIFEST.in
 README.rst
+pyproject.toml
 setup.cfg
-setup.py
 python_osc.egg-info/PKG-INFO
 python_osc.egg-info/SOURCES.txt
 python_osc.egg-info/dependency_links.txt
@@ -15,6 +15,7 @@ pythonosc/osc_message.py
 pythonosc/osc_message_builder.py
 pythonosc/osc_packet.py
 pythonosc/osc_server.py
+pythonosc/py.typed
 pythonosc/udp_client.py
 pythonosc/parsing/__init__.py
 pythonosc/parsing/ntp.py

{python-osc-1.8.0 → python-osc-1.8.2}/pythonosc/dispatcher.py

@@ -6,8 +6,7 @@ import logging
 import re
 import time
 from pythonosc import osc_packet
-from typing import overload, List, Union, Any, Generator, Tuple
-from types import FunctionType
+from typing import overload, List, Union, Any, Generator, Tuple, Callable, Optional, DefaultDict
 from pythonosc.osc_message import OscMessage
 
 
@@ -19,7 +18,7 @@ class Handler(object):
     message if any were passed.
     """
 
-    def __init__(self, _callback: FunctionType, _args: Union[Any, List[Any]],
+    def __init__(self, _callback: Callable, _args: Union[Any, List[Any]],
                  _needs_reply_address: bool = False) -> None:
         """
         Args:
@@ -32,13 +31,13 @@ class Handler(object):
         self.needs_reply_address = _needs_reply_address
 
     # needed for test module
-    def __eq__(self, other) -> bool:
+    def __eq__(self, other: Any) -> bool:
         return (type(self) == type(other) and
                 self.callback == other.callback and
                 self.args == other.args and
                 self.needs_reply_address == other.needs_reply_address)
 
-    def invoke(self, client_address: str, message: OscMessage) -> None:
+    def invoke(self, client_address: Tuple[str, int], message: OscMessage) -> None:
         """Invokes the associated callback function
 
         Args:
@@ -64,10 +63,10 @@ class Dispatcher(object):
     """
 
     def __init__(self) -> None:
-        self._map = collections.defaultdict(list)
-        self._default_handler = None
+        self._map = collections.defaultdict(list)  # type: DefaultDict[str, List[Handler]]
+        self._default_handler = None  # type: Optional[Handler]
 
-    def map(self, address: str, handler: FunctionType, *args: Union[Any, List[Any]],
+    def map(self, address: str, handler: Callable, *args: Union[Any, List[Any]],
             needs_reply_address: bool = False) -> Handler:
         """Map an address to a handler
 
@@ -108,7 +107,7 @@ class Dispatcher(object):
         pass
 
     @overload
-    def unmap(self, address: str, handler: FunctionType, *args: Union[Any, List[Any]],
+    def unmap(self, address: str, handler: Callable, *args: Union[Any, List[Any]],
               needs_reply_address: bool = False) -> None:
         """Remove an already mapped handler from an address
 
@@ -133,7 +132,7 @@ class Dispatcher(object):
             if str(e) == "list.remove(x): x not in list":
                 raise ValueError("Address '%s' doesn't have handler '%s' mapped to it" % (address, handler)) from e
 
-    def handlers_for_address(self, address_pattern: str) -> Generator[None, Handler, None]:
+    def handlers_for_address(self, address_pattern: str) -> Generator[Handler, None, None]:
         """Yields handlers matching an address
 
 
@@ -195,7 +194,7 @@ class Dispatcher(object):
         except osc_packet.ParseError:
             pass
 
-    def set_default_handler(self, handler: FunctionType, needs_reply_address: bool = False) -> None:
+    def set_default_handler(self, handler: Callable, needs_reply_address: bool = False) -> None:
         """Sets the default handler
 
         The default handler is invoked every time no other handler is mapped to an address.

{python-osc-1.8.0 → python-osc-1.8.2}/pythonosc/osc_bundle.py

@@ -3,7 +3,7 @@ import logging
 from pythonosc import osc_message
 from pythonosc.parsing import osc_types
 
-from typing import Any, Iterator
+from typing import Any, Iterator, List, Union
 
 _BUNDLE_PREFIX = b"#bundle\x00"
 
@@ -37,10 +37,8 @@ class OscBundle(object):
         # Get the contents as a list of OscBundle and OscMessage.
         self._contents = self._parse_contents(index)
 
-    # Return type is actually List[OscBundle], but that would require import annotations from __future__, which is
-    # python 3.7+ only.
-    def _parse_contents(self, index: int) -> Any:
-        contents = []
+    def _parse_contents(self, index: int) -> List[Union['OscBundle', osc_message.OscMessage]]:
+        contents = []  # type: List[Union[OscBundle, osc_message.OscMessage]]
 
         try:
             # An OSC Bundle Element consists of its size and its contents.
@@ -61,7 +59,7 @@ class OscBundle(object):
                     contents.append(osc_message.OscMessage(content_dgram))
                 else:
                     logging.warning(
-                        "Could not identify content type of dgram %s" % content_dgram)
+                        "Could not identify content type of dgram %r" % content_dgram)
         except (osc_types.ParseError, osc_message.ParseError, IndexError) as e:
             raise ParseError("Could not parse a content datagram: %s" % e)
 
@@ -73,7 +71,7 @@ class OscBundle(object):
         return dgram.startswith(_BUNDLE_PREFIX)
 
     @property
-    def timestamp(self) -> int:
+    def timestamp(self) -> float:
         """Returns the timestamp associated with this bundle."""
         return self._timestamp
 
@@ -92,7 +90,7 @@ class OscBundle(object):
         """Returns the datagram from which this bundle was built."""
         return self._dgram
 
-    def content(self, index) -> Any:
+    def content(self, index: int) -> Any:
         """Returns the bundle's content 0-indexed."""
         return self._contents[index]
 

{python-osc-1.8.0 → python-osc-1.8.2}/pythonosc/osc_bundle_builder.py

@@ -1,5 +1,7 @@
 """Build OSC bundles for client applications."""
 
+from typing import List
+
 from pythonosc import osc_bundle
 from pythonosc import osc_message
 from pythonosc.parsing import osc_types
@@ -23,7 +25,7 @@ class OscBundleBuilder(object):
                        seconds since the epoch in UTC or IMMEDIATELY.
         """
         self._timestamp = timestamp
-        self._contents = []
+        self._contents = []  # type: List[osc_bundle.OscBundle]
 
     def add_content(self, content: osc_bundle.OscBundle) -> None:
         """Add a new content to this bundle.

{python-osc-1.8.0 → python-osc-1.8.2}/pythonosc/osc_message.py

@@ -19,7 +19,7 @@ class OscMessage(object):
 
     def __init__(self, dgram: bytes) -> None:
         self._dgram = dgram
-        self._parameters = []
+        self._parameters = []  # type: List[Any]
         self._parse_datagram()
 
     def _parse_datagram(self) -> None:
@@ -34,10 +34,11 @@ class OscMessage(object):
             if type_tag.startswith(','):
                 type_tag = type_tag[1:]
 
-            params = []
+            params = []  # type: List[Any]
             param_stack = [params]
             # Parse each parameter given its type.
             for param in type_tag:
+                val = NotImplemented  # type: Any
                 if param == "i":  # Integer.
                     val, index = osc_types.get_int(self._dgram, index)
                 elif param == "h":  # Int64.
@@ -60,8 +61,10 @@ class OscMessage(object):
                     val = True
                 elif param == "F":  # False.
                     val = False
+                elif param == "N":  # Nil.
+                    val = None
                 elif param == "[":  # Array start.
-                    array = []
+                    array = []  # type: List[Any]
                     param_stack[-1].append(array)
                     param_stack.append(array)
                 elif param == "]":  # Array stop.
@@ -105,6 +108,6 @@ class OscMessage(object):
         """Convenience method for list(self) to get the list of parameters."""
         return list(self)
 
-    def __iter__(self) -> Iterator[float]:
+    def __iter__(self) -> Iterator[Any]:
         """Returns an iterator over the parameters of this message."""
         return iter(self._parameters)