Skip to content

Commit

Permalink
Typing and code cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexdlaird
alexdlaird committed Nov 6, 2024
1 parent 85f10f8 commit 534a442
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 60 deletions.
12 changes: 5 additions & 7 deletions pyngrok/exception.py
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
__copyright__ = "Copyright (c) 2018-2024 Alex Laird"
__license__ = "MIT"

from typing import Any, List, Optional
from typing import Any, List, Optional, Union, Dict, MutableMapping

from pyngrok.log import NgrokLog

Expand Down Expand Up @@ -33,7 +33,7 @@ class PyngrokNgrokError(PyngrokError):
"""

def __init__(self,
error: str,
error: Union[str, BaseException],
ngrok_logs: Optional[List[NgrokLog]] = None,
ngrok_error: Optional[str] = None) -> None:
super(PyngrokNgrokError, self).__init__(error)
Expand All @@ -50,13 +50,12 @@ class PyngrokNgrokHTTPError(PyngrokNgrokError):
contains the error response received from ``ngrok``.
"""

# When Python <3.9 support is dropped, headers type can be changed to Dict[str, str]|MutableMapping[str, str]|Any
def __init__(self,
error: str,
error: Union[str, BaseException],
url: str,
status_code: int,
message: Optional[str],
headers: Any,
headers: Union[Dict[str, str], MutableMapping[str, str], Any],
body: str) -> None:
super(PyngrokNgrokHTTPError, self).__init__(error)

Expand All @@ -77,9 +76,8 @@ class PyngrokNgrokURLError(PyngrokNgrokError):
Raised when an error occurs when trying to initiate an API request.
"""

# When Python <3.9 support is dropped, reason type can be changed to str|BaseException
def __init__(self,
error: str,
error: Union[str, BaseException],
reason: Any) -> None:
super(PyngrokNgrokURLError, self).__init__(error)

Expand Down
111 changes: 59 additions & 52 deletions pyngrok/ngrok.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import sys
import uuid
from http import HTTPStatus
from typing import Any, Dict, List, Optional, Tuple
from typing import Any, Dict, List, Optional, Tuple, Union
from urllib.error import HTTPError, URLError
from urllib.parse import urlencode
from urllib.request import Request, urlopen
Expand Down Expand Up @@ -156,8 +156,8 @@ def get_ngrok_process(pyngrok_config: Optional[PyngrokConfig] = None) -> NgrokPr
return process.get_process(pyngrok_config)


def _apply_cloud_edge_to_tunnel(tunnel: NgrokTunnel,
pyngrok_config: PyngrokConfig) -> None:
def _apply_edge_to_tunnel(tunnel: NgrokTunnel,
pyngrok_config: PyngrokConfig) -> None:
if not tunnel.public_url and pyngrok_config.api_key and tunnel.id:
tunnel_response = api_request(f"https://api.ngrok.com/tunnels/{tunnel.id}", method="GET",
auth=pyngrok_config.api_key)
Expand Down Expand Up @@ -187,9 +187,60 @@ def _apply_cloud_edge_to_tunnel(tunnel: NgrokTunnel,
tunnel.proto = edges_prefix


# When Python <3.9 support is dropped, addr type can be changed to Optional[str|int]
def _interpolate_tunnel_definition(addr: Optional[str] = None,
proto: Optional[Union[str, int]] = None,
name: Optional[str] = None,
pyngrok_config: Optional[PyngrokConfig] = None,
**options: Any):
config_path = conf.get_config_path(pyngrok_config)

if os.path.exists(config_path):
config = installer.get_ngrok_config(config_path, ngrok_version=pyngrok_config.ngrok_version)
else:
config = get_default_config(pyngrok_config.ngrok_version)

tunnel_definitions = config.get("tunnels", {})
# If a "pyngrok-default" tunnel definition exists in the ngrok config, use that
if not name and "pyngrok-default" in tunnel_definitions:
name = "pyngrok-default"

# Use a tunnel definition for the given name, if it exists
if name and name in tunnel_definitions:
tunnel_definition = tunnel_definitions[name]

if "labels" in tunnel_definition and "bind_tls" in options:
raise PyngrokError("\"bind_tls\" cannot be set when \"labels\" is also on the tunnel definition.")

addr = tunnel_definition.get("addr") if not addr else addr
proto = tunnel_definition.get("proto") if not proto else proto
# Use the tunnel definition as the base, but override with any passed in options
tunnel_definition.update(options)
options = tunnel_definition

if "labels" in options and not pyngrok_config.api_key:
raise PyngrokError(
"\"PyngrokConfig.api_key\" must be set when \"labels\" is on the tunnel definition.")

addr = str(addr) if addr else "80"
# Only apply a default proto label if "labels" isn't defined
if not proto and "labels" not in options:
proto = "http"

if not name:
if not addr.startswith("file://"):
name = f"{proto}-{addr}-{uuid.uuid4()}"
else:
name = f"{proto}-file-{uuid.uuid4()}"

config = {
"name": name,
"addr": addr
}
options.update(config)


def connect(addr: Optional[str] = None,
proto: Optional[str] = None,
proto: Optional[Union[str, int]] = None,
name: Optional[str] = None,
pyngrok_config: Optional[PyngrokConfig] = None,
**options: Any) -> NgrokTunnel:
Expand Down Expand Up @@ -240,54 +291,10 @@ def connect(addr: Optional[str] = None,
if pyngrok_config is None:
pyngrok_config = conf.get_default()

config_path = conf.get_config_path(pyngrok_config)

if os.path.exists(config_path):
config = installer.get_ngrok_config(config_path, ngrok_version=pyngrok_config.ngrok_version)
else:
config = get_default_config(pyngrok_config.ngrok_version)

tunnel_definitions = config.get("tunnels", {})
# If a "pyngrok-default" tunnel definition exists in the ngrok config, use that
if not name and "pyngrok-default" in tunnel_definitions:
name = "pyngrok-default"

# Use a tunnel definition for the given name, if it exists
if name and name in tunnel_definitions:
tunnel_definition = tunnel_definitions[name]

if "labels" in tunnel_definition and "bind_tls" in options:
raise PyngrokError("\"bind_tls\" cannot be set when \"labels\" is also on the tunnel definition.")

addr = tunnel_definition.get("addr") if not addr else addr
proto = tunnel_definition.get("proto") if not proto else proto
# Use the tunnel definition as the base, but override with any passed in options
tunnel_definition.update(options)
options = tunnel_definition

if "labels" in options and not pyngrok_config.api_key:
raise PyngrokError(
"\"PyngrokConfig.api_key\" must be set when \"labels\" is on the tunnel definition.")

addr = str(addr) if addr else "80"
# Only apply a default proto label if "labels" isn't defined
if not proto and "labels" not in options:
proto = "http"

if not name:
if not addr.startswith("file://"):
name = f"{proto}-{addr}-{uuid.uuid4()}"
else:
name = f"{proto}-file-{uuid.uuid4()}"
_interpolate_tunnel_definition(addr, proto, name, pyngrok_config, **options)

logger.info(f"Opening tunnel named: {name}")

config = {
"name": name,
"addr": addr
}
options.update(config)

# Only apply proto when "labels" is not defined
if "labels" not in options:
options["proto"] = proto
Expand Down Expand Up @@ -326,7 +333,7 @@ def connect(addr: Optional[str] = None,
timeout=pyngrok_config.request_timeout),
pyngrok_config, api_url)

_apply_cloud_edge_to_tunnel(tunnel, pyngrok_config)
_apply_edge_to_tunnel(tunnel, pyngrok_config)

if tunnel.public_url is None:
raise PyngrokError(
Expand Down Expand Up @@ -397,7 +404,7 @@ def get_tunnels(pyngrok_config: Optional[PyngrokConfig] = None) -> List[NgrokTun
for tunnel in api_request(f"{api_url}/api/tunnels", method="GET",
timeout=pyngrok_config.request_timeout)["tunnels"]:
ngrok_tunnel = NgrokTunnel(tunnel, pyngrok_config, api_url)
_apply_cloud_edge_to_tunnel(ngrok_tunnel, pyngrok_config)
_apply_edge_to_tunnel(ngrok_tunnel, pyngrok_config)

if ngrok_tunnel.public_url is None:
raise PyngrokError(
Expand Down
2 changes: 1 addition & 1 deletion tests/test_ngrok.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -687,7 +687,7 @@ def test_tunnel_definitions_tls(self):
"NGROK_HTTP_EDGE_ENDPOINT environment variable not set")
@unittest.skipIf("NGROK_TCP_EDGE_ENDPOINT" not in os.environ,
"NGROK_TCP_EDGE_ENDPOINT environment variable not set")
def test_ngrok_v3_cloud_edge_tunnel_definition(self):
def test_ngrok_v3_edge_tunnel_definition(self):
# GIVEN
config = {
"tunnels": {
Expand Down

0 comments on commit 534a442

Please sign in to comment.