1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
# ==================================================================================================================== #
# _____ _ _ ____ _ ____ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / ___| ___ _ __ ___ _ __(_) ___| _ \ __ _| |_| |__ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` || | _ / _ \ '_ \ / _ \ '__| |/ __| |_) / _` | __| '_ \ #
# | |_) | |_| || | (_) | (_) | | | | | | (_| || |_| | __/ | | | __/ | | | (__| __/ (_| | |_| | | | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____|\___|_| |_|\___|_| |_|\___|_| \__,_|\__|_| |_| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2024 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
from enum import IntFlag
from re import compile as re_compile
from typing import Dict, Optional as Nullable
try:
from pyTooling.Decorators import export, readonly
from pyTooling.GenericPath import RootMixIn, ElementMixIn, PathMixIn
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.GenericPath.URL] Could not import from 'pyTooling.*'!")
try:
from Decorators import export, readonly
from GenericPath import RootMixIn, ElementMixIn, PathMixIn
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.GenericPath.URL] Could not import directly!")
raise ex
regExp = re_compile(r"^(?:(?P<scheme>\w+)://)?(?:(?P<host>(?:\w+|\.)+)(?:\:(?P<port>\d+))?)?(?P<path>[^?#]*)(?:\?(?P<query>[^#]+))?(?:#(?P<fragment>.+))?$")
@export
class Protocols(IntFlag):
"""Enumeration of supported URL schemes."""
TLS = 1 #: Transport Layer Security
HTTP = 2 #: Hyper Text Transfer Protocol
HTTPS = 4 #: SSL/TLS secured HTTP
FTP = 8 #: File Transfer Protocol
FTPS = 16 #: SSL/TLS secured FTP
FILE = 32 #: Local files
@export
class Host(RootMixIn):
"""Represents a hostname (including the port number) in a URL."""
_hostname : str
_port : Nullable[int]
def __init__(self, hostname: str, port: Nullable[int] = None) -> None:
super().__init__()
self._hostname = hostname
self._port = port
@readonly
def Hostname(self) -> str:
"""Hostname or IP address as string."""
return self._hostname
@readonly
def Port(self) -> Nullable[int]:
"""Port number as integer."""
return self._port
def __str__(self) -> str:
result = self._hostname
if self._port is not None:
result += f":{self._port}"
return result
@export
class Element(ElementMixIn):
"""Derived class for the URL context."""
@export
class Path(PathMixIn):
"""Represents a path in a URL."""
ELEMENT_DELIMITER = "/" #: Delimiter symbol in URLs between path elements.
ROOT_DELIMITER = "/" #: Delimiter symbol in URLs between root element and first path element.
@classmethod
def Parse(cls, path: str, root: Nullable[Host] = None) -> "Path":
return super().Parse(path, root, cls, Element)
@export
class URL:
"""Represents a URL including scheme, host, credentials, path, query and fragment."""
_scheme: Protocols
_user: Nullable[str]
_password: Nullable[str]
_host: Nullable[Host]
_path: Path
_query: Nullable[Dict[str, str]]
_fragment: Nullable[str]
def __init__(self, scheme: Protocols, path: Path, host: Nullable[Host] = None, user: Nullable[str] = None, password: Nullable[str] = None, query: Nullable[Dict[str, str]] = None, fragment: Nullable[str] = None) -> None:
self._scheme = scheme
self._user = user
self._password = password
self._host = host
self._path = path
self._query = query
self._fragment = fragment
def __str__(self) -> str:
result = str(self._path)
if self._host is not None:
result = str(self._host) + result
if self._user is not None:
if self._password is not None:
result = f"{self._user}:{self._password}@{result}"
else:
result = f"{self._user}@{result}"
if self._scheme is not None:
result = self._scheme.name.lower() + "://" + result
if len(self._query) != 0:
result = result + "?" + "&".join([f"{key}={value}" for key, value in self._query.items()])
if self._fragment is not None:
result = result + "#" + self._fragment
return result
@readonly
def Scheme(self) -> Protocols:
return self._scheme
@readonly
def User(self) -> Nullable[str]:
return self._user
@readonly
def Password(self) -> Nullable[str]:
return self._password
@readonly
def Host(self) -> Nullable[Host]:
return self._host
@readonly
def Path(self) -> Path:
return self._path
@readonly
def Query(self) -> Nullable[Dict[str, str]]:
return self._query
@readonly
def Fragment(self) -> Nullable[str]:
return self._fragment
# http://semaphore.plc2.de:5000/api/v1/semaphore?name=Riviera&foo=bar#page2
@classmethod
def Parse(cls, path: str) -> "URL":
matches = regExp.match(path)
if matches is not None:
scheme = matches.group("scheme")
user = None # matches.group("user")
password = None # matches.group("password")
host = matches.group("host")
port = matches.group("port")
if port is not None:
port = int(port)
path = matches.group("path")
query = matches.group("query")
fragment = matches.group("fragment")
scheme = None if (scheme is None) else Protocols[scheme.upper()]
hostObj = None if (host is None) else Host(host, port)
pathObj = Path.Parse(path, hostObj)
parameters = {}
if query is not None:
for pair in query.split("&"):
key, value = pair.split("=")
parameters[key] = value
return cls(scheme, pathObj, hostObj, user, password, parameters, fragment)
else:
pass
|