uploadserver 5.2.1__tar.gz → 6.0.0__tar.gz

{uploadserver-5.2.1/uploadserver.egg-info → uploadserver-6.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uploadserver
-Version: 5.2.1
+Version: 6.0.0
 Summary: Python's http.server extended to include a file upload page
 Home-page: https://github.com/Densaugeo/uploadserver
 Author: Densaugeo
@@ -8,7 +8,7 @@ Author-email: author@example.com
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -17,14 +17,14 @@ License-File: LICENSE
 Python's http.server extended to include a file upload page
 
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://mit-license.org/)
-[![Build Status](https://travis-ci.com/Densaugeo/uploadserver.svg?branch=master)](https://travis-ci.com/github/Densaugeo/uploadserver)
+[![Build Status](https://app.travis-ci.com/Densaugeo/uploadserver.svg?branch=master)](https://app.travis-ci.com/github/Densaugeo/uploadserver)
 
 ## Supported Platforms
 
 | Platform | Supported? | Notes |
 |-|-|-|
-| Python 3.8+ | Yes | Tested on 3.8 through 3.12 every release. |
-| Python 3.6-3.7 | No | Was supported by previous versions. |
+| Python 3.9+ | Yes | Tested on 3.9 through 3.14 every release. |
+| Python 3.6-3.8 | No | Was supported by previous versions. |
 | Python 3.5- | No | |
 | Linux | Yes | Tested on Fedora and Ubuntu every release. |
 | Windows | Yes | Occasional manual testing. Haven't noticed any obvious problems. |
@@ -123,6 +123,51 @@ curl -X POST https://localhost:8000/upload --insecure --cert client.pem -F files
 
 Note: This uses a self-signed server certificate which clients such as web browser and cURL will warn about. Most browsers will allow you to proceed after adding an exception, and cURL will work if given the -k/--insecure option. Using your own certificate from a certificate authority will avoid these warnings.
 
+## Available Options
+
+```
+usage: __main__.py [-h] [--cgi] [--allow-replace] [--bind ADDRESS]
+                   [--directory DIRECTORY] [--theme {light,auto,dark}]
+                   [--server-certificate SERVER_CERTIFICATE]
+                   [--client-certificate CLIENT_CERTIFICATE]
+                   [--basic-auth BASIC_AUTH]
+                   [--basic-auth-upload BASIC_AUTH_UPLOAD]
+                   [port]
+
+positional arguments:
+  port                  Specify alternate port [default: 8000]
+
+options:
+  -h, --help            show this help message and exit
+  --cgi                 Run as CGI Server
+  --allow-replace       Replace existing file if uploaded file has the same
+                        name. Auto rename by default.
+  --bind, -b ADDRESS    Specify alternate bind address [default: all
+                        interfaces]
+  --directory, -d DIRECTORY
+                        Specify alternative directory [default:current
+                        directory]
+  --theme {light,auto,dark}
+                        Specify a light or dark theme for the upload page
+                        [default: auto]
+  --server-certificate, --certificate, -c SERVER_CERTIFICATE
+                        Specify HTTPS server certificate to use [default:
+                        none]
+  --client-certificate CLIENT_CERTIFICATE
+                        Specify HTTPS client certificate to accept for mutual
+                        TLS [default: none]
+  --basic-auth BASIC_AUTH
+                        Specify user:pass for basic authentication (downloads
+                        and uploads)
+  --basic-auth-upload BASIC_AUTH_UPLOAD
+                        Specify user:pass for basic authentication (uploads
+                        only)
+```
+
+## Breaking Changes in 6.0.0
+
+- Support for Python 3.8 dropped.
+
 ## Breaking Changes in 5.0.0
 
 - Support for Python 3.6-7 dropped.

{uploadserver-5.2.1 → uploadserver-6.0.0}/README.md

@@ -3,14 +3,14 @@
 Python's http.server extended to include a file upload page
 
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://mit-license.org/)
-[![Build Status](https://travis-ci.com/Densaugeo/uploadserver.svg?branch=master)](https://travis-ci.com/github/Densaugeo/uploadserver)
+[![Build Status](https://app.travis-ci.com/Densaugeo/uploadserver.svg?branch=master)](https://app.travis-ci.com/github/Densaugeo/uploadserver)
 
 ## Supported Platforms
 
 | Platform | Supported? | Notes |
 |-|-|-|
-| Python 3.8+ | Yes | Tested on 3.8 through 3.12 every release. |
-| Python 3.6-3.7 | No | Was supported by previous versions. |
+| Python 3.9+ | Yes | Tested on 3.9 through 3.14 every release. |
+| Python 3.6-3.8 | No | Was supported by previous versions. |
 | Python 3.5- | No | |
 | Linux | Yes | Tested on Fedora and Ubuntu every release. |
 | Windows | Yes | Occasional manual testing. Haven't noticed any obvious problems. |
@@ -109,6 +109,51 @@ curl -X POST https://localhost:8000/upload --insecure --cert client.pem -F files
 
 Note: This uses a self-signed server certificate which clients such as web browser and cURL will warn about. Most browsers will allow you to proceed after adding an exception, and cURL will work if given the -k/--insecure option. Using your own certificate from a certificate authority will avoid these warnings.
 
+## Available Options
+
+```
+usage: __main__.py [-h] [--cgi] [--allow-replace] [--bind ADDRESS]
+                   [--directory DIRECTORY] [--theme {light,auto,dark}]
+                   [--server-certificate SERVER_CERTIFICATE]
+                   [--client-certificate CLIENT_CERTIFICATE]
+                   [--basic-auth BASIC_AUTH]
+                   [--basic-auth-upload BASIC_AUTH_UPLOAD]
+                   [port]
+
+positional arguments:
+  port                  Specify alternate port [default: 8000]
+
+options:
+  -h, --help            show this help message and exit
+  --cgi                 Run as CGI Server
+  --allow-replace       Replace existing file if uploaded file has the same
+                        name. Auto rename by default.
+  --bind, -b ADDRESS    Specify alternate bind address [default: all
+                        interfaces]
+  --directory, -d DIRECTORY
+                        Specify alternative directory [default:current
+                        directory]
+  --theme {light,auto,dark}
+                        Specify a light or dark theme for the upload page
+                        [default: auto]
+  --server-certificate, --certificate, -c SERVER_CERTIFICATE
+                        Specify HTTPS server certificate to use [default:
+                        none]
+  --client-certificate CLIENT_CERTIFICATE
+                        Specify HTTPS client certificate to accept for mutual
+                        TLS [default: none]
+  --basic-auth BASIC_AUTH
+                        Specify user:pass for basic authentication (downloads
+                        and uploads)
+  --basic-auth-upload BASIC_AUTH_UPLOAD
+                        Specify user:pass for basic authentication (uploads
+                        only)
+```
+
+## Breaking Changes in 6.0.0
+
+- Support for Python 3.8 dropped.
+
 ## Breaking Changes in 5.0.0
 
 - Support for Python 3.6-7 dropped.

{uploadserver-5.2.1 → uploadserver-6.0.0}/setup.py

@@ -5,7 +5,7 @@ with open('README.md', 'r') as fh:
 
 setuptools.setup(
     name='uploadserver',
-    version='5.2.1',
+    version='6.0.0',
     author='Densaugeo',
     author_email='author@example.com',
     description='Python\'s http.server extended to include a file upload page',
@@ -18,7 +18,7 @@ setuptools.setup(
         'License :: OSI Approved :: MIT License',
         'Operating System :: OS Independent',
     ],
-    python_requires='>=3.8',
+    python_requires='>=3.9',
     entry_points = {
         'console_scripts': ['uploadserver=uploadserver:main'],
     }

{uploadserver-5.2.1 → uploadserver-6.0.0}/uploadserver/__init__.py

@@ -18,7 +18,7 @@ COLOR_SCHEME = {
     'dark': 'dark',
 }
 
-def get_upload_page(theme):
+def get_upload_page(theme: str) -> bytes:
     return bytes('''<!DOCTYPE html>
 <html>
 <head>
@@ -74,7 +74,7 @@ document.getElementsByTagName('form')[0].addEventListener('submit', async e => {
 </script>
 </html>''', 'utf-8')
 
-def get_directory_head_injection(theme):
+def get_directory_head_injection(theme: str) -> bytes:
     return bytes('''<!-- Injected by uploadserver -->
 <meta name="viewport" content="width=device-width" />
 <meta name="color-scheme" content="''' + COLOR_SCHEME.get(theme) + '''">
@@ -88,7 +88,7 @@ DIRECTORY_BODY_INJECTION = b'''<!-- Injected by uploadserver -->
 <!-- End injection by uploadserver -->
 '''
 
-def send_upload_page(handler):
+def send_upload_page(handler: http.server.BaseHTTPRequestHandler):
     handler.send_response(http.HTTPStatus.OK)
     handler.send_header('Content-Type', 'text/html; charset=utf-8')
     handler.send_header('Content-Length', len(get_upload_page(args.theme)))
@@ -99,7 +99,7 @@ class PersistentFieldStorage(cgi.FieldStorage):
     # Override cgi.FieldStorage.make_file() method. Valid for Python 3.1 ~ 3.10.
     # Modified version of the original .make_file() method (base copied from
     # Python 3.10)
-    def make_file(self):
+    def make_file(self) -> object:
         if self._binary_file:
             return tempfile.NamedTemporaryFile(mode = 'wb+',
                 dir = args.directory, delete = False)
@@ -107,7 +107,9 @@ class PersistentFieldStorage(cgi.FieldStorage):
             return tempfile.NamedTemporaryFile("w+", dir = args.directory,
                 delete = False, encoding = self.encoding, newline = '\n')
 
-def auto_rename(path):
+# True argument/return type is str | pathlib.Path, but Python 3.9 doesn't
+# support |
+def auto_rename(path: pathlib.Path) -> pathlib.Path:
     if not os.path.exists(path):
         return path
     (base, ext) = os.path.splitext(path)
@@ -117,7 +119,8 @@ def auto_rename(path):
             return renamed_path
     raise FileExistsError(f'File {path} already exists.')
 
-def receive_upload(handler):
+def receive_upload(handler: http.server.BaseHTTPRequestHandler,
+) -> tuple[http.HTTPStatus, str]:
     result = (http.HTTPStatus.INTERNAL_SERVER_ERROR, 'Server error')
     name_conflict = False
     
@@ -153,16 +156,19 @@ def receive_upload(handler):
                 os.rename(source, destination)
             # class '_io.BytesIO', small file (< 1000B, in cgi.py), in-memory
             # buffer
-            else: 
+            else:
                 with open(destination, 'wb') as f:
                     f.write(field.file.read())
-            handler.log_message(f'[Uploaded] "{filename}" --> {destination}')
+            handler.log_message('[Uploaded] "%s" --> %s', filename, destination)
             result = (http.HTTPStatus.NO_CONTENT, 'Some filename(s) changed '
                 'due to name conflict' if name_conflict else 'Files accepted')
     
     return result
 
-def check_http_authentication_header(handler, auth):
+# True return type is tuple[bool, str | None], but Python 3.9 doesn't support |
+def check_http_authentication_header(
+handler: http.server.BaseHTTPRequestHandler, auth: str,
+) -> tuple[bool, str]:
     auth_header = handler.headers.get('Authorization')
     if auth_header is None:
         return (False, 'No credentials given')
@@ -186,7 +192,8 @@ def check_http_authentication_header(handler, auth):
     
     return (True, None)
 
-def check_http_authentication(handler):
+def check_http_authentication(handler: http.server.BaseHTTPRequestHandler
+) -> bool:
     """
     This function should be called in at the beginning of HTTP method handler.
     It validates Authorization header and sends back 401 response on failure.
@@ -219,7 +226,7 @@ def check_http_authentication(handler):
                     valid, message = check_http_authentication_header(handler, args.basic_auth_upload)
     
     if not valid:
-        handler.log_message(f'Request rejected ({message})')
+        handler.log_message('Request rejected (%s)', message)
         handler.send_response(http.HTTPStatus.UNAUTHORIZED, message)
         handler.send_header('WWW-Authenticate', 'Basic realm="uploadserver"')
         handler.end_headers()
@@ -251,7 +258,8 @@ class ListDirectoryInterception:
         content = content.replace(b'<ul>', DIRECTORY_BODY_INJECTION + b'<ul>')
         outputfile.write(content)
     
-    def list_directory(self, path):
+    # True argument type is str | pathlib.Path, but Python 3.9 doesn't support |
+    def list_directory(self, path: pathlib.Path) -> object:
         setattr(self, 'flush_headers', self.flush_headers_interceptor)
         setattr(self, 'copyfile', self.copyfile_interceptor)
         
@@ -323,7 +331,7 @@ def intercept_first_print():
             builtins.print = old_print
         builtins.print = new_print
 
-def ssl_wrap(socket):
+def ssl_wrap(socket: socket.socket) -> ssl.SSLSocket:
     context = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
     server_root = pathlib.Path(args.directory).resolve()
     
@@ -339,7 +347,14 @@ def ssl_wrap(socket):
             f'root "{server_root}", exiting')
         sys.exit(3)
     
-    context.load_cert_chain(certfile=server_certificate)
+    try:
+        context.load_cert_chain(certfile=server_certificate)
+    except ssl.SSLError as e:
+        print(f'Unable to load certificate "{server_certificate}", exiting\n\n'
+            f'NOTE: Certificate must be a single file in .pem format. If you '
+            'have multiple certificate files, such as Let\'s Encrypt provides, '
+            'you can cat them together to get one file.')
+        sys.exit(4)
     
     if args.client_certificate:
         # Client certificate handling

{uploadserver-5.2.1 → uploadserver-6.0.0/uploadserver.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uploadserver
-Version: 5.2.1
+Version: 6.0.0
 Summary: Python's http.server extended to include a file upload page
 Home-page: https://github.com/Densaugeo/uploadserver
 Author: Densaugeo
@@ -8,7 +8,7 @@ Author-email: author@example.com
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 
@@ -17,14 +17,14 @@ License-File: LICENSE
 Python's http.server extended to include a file upload page
 
 [![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://mit-license.org/)
-[![Build Status](https://travis-ci.com/Densaugeo/uploadserver.svg?branch=master)](https://travis-ci.com/github/Densaugeo/uploadserver)
+[![Build Status](https://app.travis-ci.com/Densaugeo/uploadserver.svg?branch=master)](https://app.travis-ci.com/github/Densaugeo/uploadserver)
 
 ## Supported Platforms
 
 | Platform | Supported? | Notes |
 |-|-|-|
-| Python 3.8+ | Yes | Tested on 3.8 through 3.12 every release. |
-| Python 3.6-3.7 | No | Was supported by previous versions. |
+| Python 3.9+ | Yes | Tested on 3.9 through 3.14 every release. |
+| Python 3.6-3.8 | No | Was supported by previous versions. |
 | Python 3.5- | No | |
 | Linux | Yes | Tested on Fedora and Ubuntu every release. |
 | Windows | Yes | Occasional manual testing. Haven't noticed any obvious problems. |
@@ -123,6 +123,51 @@ curl -X POST https://localhost:8000/upload --insecure --cert client.pem -F files
 
 Note: This uses a self-signed server certificate which clients such as web browser and cURL will warn about. Most browsers will allow you to proceed after adding an exception, and cURL will work if given the -k/--insecure option. Using your own certificate from a certificate authority will avoid these warnings.
 
+## Available Options
+
+```
+usage: __main__.py [-h] [--cgi] [--allow-replace] [--bind ADDRESS]
+                   [--directory DIRECTORY] [--theme {light,auto,dark}]
+                   [--server-certificate SERVER_CERTIFICATE]
+                   [--client-certificate CLIENT_CERTIFICATE]
+                   [--basic-auth BASIC_AUTH]
+                   [--basic-auth-upload BASIC_AUTH_UPLOAD]
+                   [port]
+
+positional arguments:
+  port                  Specify alternate port [default: 8000]
+
+options:
+  -h, --help            show this help message and exit
+  --cgi                 Run as CGI Server
+  --allow-replace       Replace existing file if uploaded file has the same
+                        name. Auto rename by default.
+  --bind, -b ADDRESS    Specify alternate bind address [default: all
+                        interfaces]
+  --directory, -d DIRECTORY
+                        Specify alternative directory [default:current
+                        directory]
+  --theme {light,auto,dark}
+                        Specify a light or dark theme for the upload page
+                        [default: auto]
+  --server-certificate, --certificate, -c SERVER_CERTIFICATE
+                        Specify HTTPS server certificate to use [default:
+                        none]
+  --client-certificate CLIENT_CERTIFICATE
+                        Specify HTTPS client certificate to accept for mutual
+                        TLS [default: none]
+  --basic-auth BASIC_AUTH
+                        Specify user:pass for basic authentication (downloads
+                        and uploads)
+  --basic-auth-upload BASIC_AUTH_UPLOAD
+                        Specify user:pass for basic authentication (uploads
+                        only)
+```
+
+## Breaking Changes in 6.0.0
+
+- Support for Python 3.8 dropped.
+
 ## Breaking Changes in 5.0.0
 
 - Support for Python 3.6-7 dropped.