portforward 0.6.1__cp38-none-win_amd64.whl → 0.7.0__cp38-none-win_amd64.whl

portforward/__init__.py

@@ -2,14 +2,15 @@
 Easy Kubernetes Port-Forward For Python
 """
 
-__version__ = "0.6.1"
+__version__ = "0.7.0"
 
 import asyncio
 import contextlib
+import ipaddress
 import os
 from enum import Enum
 from pathlib import Path
-from typing import Generator, Optional
+from typing import Generator, Optional, Union
 
 from portforward import _portforward
 
@@ -36,6 +37,7 @@ def forward(
     waiting: float = 0.1,
     log_level: LogLevel = LogLevel.INFO,
     kube_context: str = "",
+    bind_ip: Union[ipaddress.IPv4Address, ipaddress.IPv6Address, str, None] = None,
 ) -> Generator["PortForwarder", None, None]:
     """
     Connects to a **pod or service** and tunnels traffic from a local port to
@@ -52,21 +54,16 @@ def forward(
         >>> import portforward
         >>> with portforward.forward("test", "web-svc", 9000, 80):
         >>>     # Do work
-        >>>
-        >>> # Or without context manager
-        >>>
-        >>> forwarder = portforward.forward("test", "some-pod", 9000, 80)
-        >>> # Do work
-        >>> forwarder.stop()
 
     :param namespace: Target namespace
     :param pod_or_service: Name of target Pod or service
-    :param from_port: Local port
+    :param from_port: Local port, or 0 to use any free port
     :param to_port: Port inside the pod
     :param config_path: Path for loading kube config
     :param waiting: Delay in seconds
     :param log_level: Level of logging
     :param kube_context: Target kubernetes context (fallback is current context)
+    :param bind_ip: To which IP shall the portforward be bind
     :return: forwarder to manual stop the forwarding
     """
 
@@ -79,6 +76,7 @@ def forward(
         waiting,
         log_level,
         kube_context,
+        bind_ip,
     )
 
     try:
@@ -107,6 +105,7 @@ class PortForwarder:
         waiting: float = 0.1,
         log_level: LogLevel = LogLevel.INFO,
         kube_context: str = "",
+        bind_ip: Union[ipaddress.IPv4Address, ipaddress.IPv6Address, str, None] = None,
     ) -> None:
         self._async_forwarder = AsyncPortForwarder(
             namespace,
@@ -117,6 +116,7 @@ class PortForwarder:
             waiting,
             log_level,
             kube_context,
+            bind_ip,
         )
 
     def forward(self):
@@ -129,6 +129,11 @@ class PortForwarder:
     def is_stopped(self):
         return self._async_forwarder.is_stopped
 
+    @property
+    def from_port(self):
+        """The local port that was actually used for the portforward."""
+        return self._async_forwarder.from_port
+
 
 class AsyncPortForwarder:
     """Use the same args as the `portforward.forward` method."""
@@ -143,10 +148,10 @@ class AsyncPortForwarder:
         waiting: float = 0.1,
         log_level: LogLevel = LogLevel.INFO,
         kube_context: str = "",
+        bind_ip: Union[ipaddress.IPv4Address, ipaddress.IPv6Address, str, None] = None,
     ) -> None:
         self.namespace: str = _validate_str("namespace", namespace)
         self.pod_or_service: str = _validate_str("pod_or_service", pod_or_service)
-        self.from_port: int = _validate_port("from_port", from_port)
         self.to_port: int = _validate_port("to_port", to_port)
         self.log_level: LogLevel = _validate_log(log_level)
         self.waiting: float = waiting
@@ -154,14 +159,19 @@ class AsyncPortForwarder:
         self.config_path: str = _config_path(config_path)
         self.kube_context: str = _kube_context(kube_context)
 
+        _validate_port("from_port", from_port)
+        bind_ip = _validate_ip_address(bind_ip)
+
         self.actual_pod_name: str = ""
+        self.from_port: int = 0
         self._is_stopped: bool = False
+        self.bind_address: str = f"{bind_ip}:{from_port}"
 
     async def forward(self):
-        self.actual_pod_name = await _portforward.forward(
+        (self.actual_pod_name, self.from_port) = await _portforward.forward(
             self.namespace,
             self.pod_or_service,
-            self.from_port,
+            self.bind_address,
             self.to_port,
             self.config_path,
             self.log_level.value,
@@ -196,7 +206,7 @@ def _validate_str(arg_name, arg) -> str:
 
 
 def _validate_port(arg_name, arg) -> int:
-    in_range = arg and 0 < arg < 65536
+    in_range = arg is not None and 0 <= arg < 65536
     if arg is None or not isinstance(arg, int) or not in_range:
         raise ValueError(f"{arg_name}={arg} is not a valid port")
 
@@ -210,6 +220,18 @@ def _validate_log(log_level):
     return log_level
 
 
+def _validate_ip_address(ip_address):
+    if not ip_address:
+        return "127.0.0.1"
+
+    if isinstance(ip_address, ipaddress.IPv4Address) or isinstance(
+        ip_address, ipaddress.IPv4Address
+    ):
+        return str(ip_address)
+
+    return str(ipaddress.ip_address(ip_address))
+
+
 def _config_path(config_path_arg) -> str:
     if config_path_arg and not isinstance(config_path_arg, str):
         raise ValueError(f"config_path={config_path_arg} is not a valid str")

portforward/_portforward.pyi

@@ -5,7 +5,7 @@ Rust native module / Python C Extension
 async def forward(
     namespace: str,
     pod_or_service: str,
-    from_port: int,
+    bind_address: str,
     to_port: int,
     config_path: str,
     log_level: int,

{portforward-0.6.1.dist-info → portforward-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: portforward
-Version: 0.6.1
+Version: 0.7.0
 Classifier: Programming Language :: Rust
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
@@ -18,9 +18,9 @@ Author-email: Sebastian Ziemann <corka149@mailbox.org>
 License: MIT License
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst; charset=UTF-8
-Project-URL: Changelog, https://github.com/pytogo/portforward/blob/main/HISTORY.rst
 Project-URL: Documentation, https://portforward.readthedocs.io
 Project-URL: Repository, https://github.com/pytogo/portforward.git
+Project-URL: Changelog, https://github.com/pytogo/portforward/blob/main/HISTORY.rst
 
 ===========
 portforward
@@ -58,22 +58,17 @@ Installation
 
 Wheels are available for:
 
-* Windows
-* MacOS X
-* Linux
+* Windows (architectures: x64, x86)
+* MacOS X (architectures: x86_64, aarch64)
+* Linux (architectures: x86_64, x86, aarch64)
 
 with Python versions:
 
-* 3.7
 * 3.8
 * 3.9
 * 3.10
 * 3.11
-
-and architectures:
-
-* x84_64
-* arm64 (known as M1/Apple Chip - MacOS only)
+* 3.12
 
 **Requirements for installation from source**
 

portforward-0.7.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+portforward-0.7.0.dist-info/METADATA,sha256=VroXlyz-o2jJGMhoJChOdr_UkFKntF4aJZTtc81ozCs,3844
+portforward-0.7.0.dist-info/WHEEL,sha256=VvdY44iN3gVotPLSbm-bn6F9k45H_kxH9jQNBi2QPzw,96
+portforward-0.7.0.dist-info/license_files/LICENSE,sha256=_-nf_xCZIwUkKBXXiYR-fjbXGhmx6V-7b3jSKoolnO4,1096
+portforward-0.7.0.dist-info/license_files/AUTHORS.rst,sha256=mskf9O-AvJL9NxWUYX0nJRuLfBw7SH-T-H-pPYLW-xI,176
+portforward/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+portforward/_portforward.pyi,sha256=UDGuRjzq4fFH2vyVMKGpsBQvYq8MK0LfFsM1FxljTX4,353
+portforward/__init__.py,sha256=k5ue6jwiYqPBRzulv2BdfWiTHj05Qg4jlY0WtEJeV8M,7318
+portforward/_portforward.cp38-win_amd64.pyd,sha256=7qNISVVfV3j-j03uYm_1Iw_2jsTMTmotK-22krjM96A,8160256
+portforward-0.7.0.dist-info/RECORD,,

portforward-0.6.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-portforward-0.6.1.dist-info/METADATA,sha256=ha20PYNU00AWz2MtY8Kc5wbovKcGthMbOlDx2KGqqVE,3827
-portforward-0.6.1.dist-info/WHEEL,sha256=VvdY44iN3gVotPLSbm-bn6F9k45H_kxH9jQNBi2QPzw,96
-portforward-0.6.1.dist-info/license_files/LICENSE,sha256=_-nf_xCZIwUkKBXXiYR-fjbXGhmx6V-7b3jSKoolnO4,1096
-portforward-0.6.1.dist-info/license_files/AUTHORS.rst,sha256=mskf9O-AvJL9NxWUYX0nJRuLfBw7SH-T-H-pPYLW-xI,176
-portforward/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-portforward/_portforward.pyi,sha256=iZTDdh3rwEtEfNOcVV69xgiqyPOV7n6LUNAiKPSAbII,350
-portforward/__init__.py,sha256=CsUXCFRZ878GUAFp8TI5cnocdQ7Cm1kF617iyzyd6j0,6475
-portforward/_portforward.cp38-win_amd64.pyd,sha256=Z6aXCjBjkWZr_EAKZqSh4UJtymeiGAKcI4jmXBlKHOY,10797568
-portforward-0.6.1.dist-info/RECORD,,