random-port 0.0.8__py3-none-any.whl

random_port/__init__.py

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2025 Fabrício Barros Cabral
+#
+# 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 the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# 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 NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS 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.

random_port/pool.py

@@ -0,0 +1,114 @@
+# The MIT License (MIT)
+#
+# Copyright (C) 2025 Fabrício Barros Cabral
+#
+# 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 the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# 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 NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS 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.
+import random
+import socket
+from abc import ABC, abstractmethod
+
+
+class Port(ABC):
+    @abstractmethod
+    def value(self) -> int:
+        pass
+
+
+class TcpRandomPort(Port):
+    def __init__(
+        self, host: str = "127.0.0.1", begin: int = 1024, end: int = 65536
+    ) -> None:
+        self.__host = host
+        self.__begin = begin
+        self.__end = end
+
+    def value(self) -> int:
+        def is_tcp_port_in_use(host: str, port: int) -> bool:
+            with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sckt:
+                try:
+                    sckt.bind((host, port))
+                except OSError:
+                    return True
+                return False
+
+        port = random.randint(self.__begin, self.__end)
+        while is_tcp_port_in_use(self.__host, port):
+            port = random.randint(self.__begin, self.__end)
+        return port
+
+
+class UdpRandomPort(Port):
+    def __init__(
+        self, host: str = "127.0.0.1", begin: int = 1024, end: int = 65536
+    ) -> None:
+        self.__host = host
+        self.__begin = begin
+        self.__end = end
+
+    def value(self) -> int:
+        def is_udp_port_in_use(host: str, port: int) -> bool:
+            with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sckt:
+                try:
+                    sckt.bind((host, port))
+                except OSError:
+                    return True
+                return False
+
+        port = random.randint(self.__begin, self.__end)
+        while is_udp_port_in_use(self.__host, port):
+            port = random.randint(self.__begin, self.__end)
+        return port
+
+
+class TcpPort(Port):
+    def __init__(self, num: int, host: str = "127.0.0.1") -> None:
+        self.__host = host
+        self.__num = num
+
+    def value(self) -> int:
+        def is_tcp_port_in_use(host: str, port: int) -> bool:
+            with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sckt:
+                try:
+                    sckt.bind((host, port))
+                except OSError:
+                    return True
+                return False
+
+        while is_tcp_port_in_use(self.__host, self.__num):
+            pass
+        return self.__num
+
+
+class UdpPort(Port):
+    def __init__(self, num: int, host: str = "127.0.0.1") -> None:
+        self.__host = host
+        self.__num = num
+
+    def value(self) -> int:
+        def is_udp_port_in_use(host: str, port: int) -> bool:
+            with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as sckt:
+                try:
+                    sckt.bind((host, port))
+                except OSError:
+                    return True
+                return False
+
+        while is_udp_port_in_use(self.__host, self.__num):
+            pass
+        return self.__num

random_port-0.0.8.dist-info/METADATA

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: random-port
+Version: 0.0.8
+Summary: Generate a free TCP or UDP random port
+Author-email: Fabrício Barros Cabral <fabriciofx@gmail.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/fabriciofx/random-port
+Project-URL: bug-tracker, https://github.com/fabriciofx/random-port/issues
+Keywords: socket,tcp,udp,random,port,test
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Dynamic: license-file
+
+# Random Port
+
+## Introduction
+
+Usually we need start a TCP or UDP server (mainly to use in tests) but, which
+port must be used? So, random-port is the answer. It generate a free random
+or fixed TCP/UDP port to be used for any server.
+
+## How to install
+
+Install it using `pip` command:
+
+```bash
+pip install random-port
+```
+
+in your project folder.
+
+## Usage
+
+- To use a TCP random port:
+
+```python
+from random_port.pool import TcpRandomPort
+
+port = TcpRandomPort().value()
+```
+
+- To use a random UDP port:
+
+```python
+from random_port.pool import UdpRandomPort
+
+port = UdpRandomPort().value()
+```
+
+- To use a fixed TCP port:
+
+```python
+from random_port.pool import TcpPort
+
+port = TcpPort(12345).value()
+```
+
+- To use a fixed UDP port:
+
+```python
+from random_port.pool import UdpPort
+
+port = UdpPort(12345).value()
+```
+
+## License
+
+The MIT License (MIT)
+
+Copyright (C) 2025 Fabrício Barros Cabral
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+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 NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS 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.

random_port-0.0.8.dist-info/RECORD

@@ -0,0 +1,8 @@
+random_port/__init__.py,sha256=WnbD7VqLlKdJ81-K8BGjxrmQLXEu_g-czd-Y73OAezQ,1129
+random_port/pool.py,sha256=HhiqgogxNnX8XjXM_LdC5wgzeMXyRQfPg3T-KSQE0-o,3877
+random_port/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+random_port-0.0.8.dist-info/licenses/LICENSE.txt,sha256=SrFTda5sgSB9hkS5IK7GpSHxGMawR9F_6099TboKYXk,1091
+random_port-0.0.8.dist-info/METADATA,sha256=TntSVhSW-dpWmXuSTrEcqnGKWk-c0O7zuP-VXDwkY1A,2406
+random_port-0.0.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+random_port-0.0.8.dist-info/top_level.txt,sha256=wypEHVVFuk5I-FKJUMe84GL6xu7FPBEa8iRY_oyqxfw,12
+random_port-0.0.8.dist-info/RECORD,,

random_port-0.0.8.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

random_port-0.0.8.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (C) 2025 Fabrício Barros Cabral
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+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 NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS 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.

random_port-0.0.8.dist-info/top_level.txt

@@ -0,0 +1 @@
+random_port