Cleanup docs

mar10 · Jan 9, 2022 · 7431578 · 7431578
1 parent 2cf357f
commit 7431578
Show file tree

Hide file tree

Showing 49 changed files with 178 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,23 +2,30 @@
 
 ## 4.0.0 / Unreleased
 
+**Breaking Changes**
 - Drop Python 2 support
 - Drop support for Python syntax in config files (wsgidav.conf)
 - Drop support for Microsoft Web Folders (option `dir_browser.ms_mount`).
-- CORS support
-- Provider root paths are relative to configuration file
-- DAVCollection, DAVNonCollection, DAVProvider are now ABCs.
-- API enforces some named keyword args (`..., *, ...`)
+- API now sometimes enforces some _named_ keyword args (`fn(<args>, *, ...)`)
 - Rename option `lock_manager` to `lock_storage`
 - Moved `lock_manager` and `lock_storage` modules to  `lock_man` package.
+- Move logging options to 'logging' section
+- Drop flup and CherryPy support from CLI (use cheroot instead of CherryPy)
+
+**New Features**
+- Add CORS support
+- hotfixes.re_encode_path_info is true by default (null evaluates to false now!)
+- Add uvicorn server support to CLI
 - `lock_storage`, `property_manager`, `provider_mapping`
    can now be configured in the YAML file to use custom implementations using
    this syntax:
    `{ "class": <class_path>, "args": [<arg>, ...], "kwargs": {"<arg_name>": <val>, ... } }`
-- hotfixes.re_encode_path_info is true by default (null evaluates to false now!)
+
+**Other changes**
+- Provider root paths are evaluated relative to the location of the configuration 
+  file 
+- DAVCollection, DAVNonCollection, DAVProvider are now ABCs.
 - Deprecate hotfixes.winxp_accept_root_share_login and hotfixes.win_accept_anonymous_options
-- Move logging options to 'logging' section
-- Add uvicorn server support to CLI, drop flup and CherryPy
 - DirBrowser supports `?davmount` URLs by default (option `dir_browser.davmount`).
   The new option `dir_browser.davmount_links` controls link display (default: false).
 - #185 Fix FileLikeQueue for Python 3

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2009-2021 Martin Wendt, (Original PyFileServer (c) 2005 Ho Chun Wei)
+Copyright (c) 2009-2022 Martin Wendt, (Original PyFileServer (c) 2005 Ho Chun Wei)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -24,7 +24,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "WsgiDAV"
-copyright = "2009-2021 Martin Wendt, 2005 Ho Chun Wei"
+copyright = "2009-2022 Martin Wendt, 2005 Ho Chun Wei"
 author = "Martin Wendt"
 
 # The full version, including alpha/beta/rc tags
@@ -134,10 +134,96 @@
 # documentation.
 # html_theme_options = {}
 
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+# html_theme = 'bootstrap'
+# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = 'logo.png'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+html_favicon = 'favicon.ico'
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+html_use_smartypants = False
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'wsgidavdoc'
 
 
 # -- Extension configuration -------------------------------------------------

diff --git a/docs/source/favicon.ico b/docs/source/favicon.ico
diff --git a/setup_bdist_msi.py b/setup_bdist_msi.py
@@ -94,7 +94,7 @@
         target_name="wsgidav.exe",
         icon="docs/source/logo.ico",
         shortcut_name="WsgiDAV",
-        copyright="(c) 2009-2021 Martin Wendt",
+        copyright="(c) 2009-2022 Martin Wendt",
         # trademarks="...",
     )
 ]
@@ -111,7 +111,7 @@
     "excludes": [
         "tkinter",
     ],
-    "constants": "BUILD_COPYRIGHT='(c) 2009-2021 Martin Wendt'",
+    "constants": "BUILD_COPYRIGHT='(c) 2009-2022 Martin Wendt'",
     # "init_script": "Console",
     "include_msvcr": True,
 }

diff --git a/tests/benchmarks.py b/tests/benchmarks.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/tests/stressor/results.md b/tests/stressor/results.md
@@ -9,6 +9,36 @@ We use it to test stressor against a locally running WsgiDAV server:
 3. Open a second terminal and run
   $ stressor run tests/stressor/test_rw.yaml -q
 ```
+
+## 2022-01-04
+WsgiDAV 4.0.0-a2
+Runtime 30 secs, 10 parallel sessions
+The script GETs a static file, PUTs a new file, GETs that file, and loops again.
+
+### Windows 10, Ryzen 5 @ 3.9 GHz
+
+- Cheroot 8.3.1 Executed  2,760 activities (~ 9 requests per user per second)
+- Cheroot 8.5.2 Executed 23,584 activities (~ 78 requests per user per second)
+- Cheroot 8.6.0 Executed  8,640 activities (~ 28 requests per user per second)
+
+Same scenario, different no. of parallel users. Best of 3
+
+|               |          | #1     | #2     | #3     | Best   |
+| ------------- | -------- | ------ | ------ | ------ | ------ |
+| Cheroot 8.5.2 |  5 users |  9,160 |  9,672 |  9,180 |  9,672 |
+|               | 10 users | 22,532 | 21,708 | 23,312 | 23,312 |
+|               | 20 users | 23,528 | 23,516 | 23,544 | 23,544 |
+| Cheroot 8.6.0 |  5 users |  2,540 |  2,540 |  2,540 |  2,540 |
+|               | 10 users |  5,008 | 10,080 |  6,604 | 10,080 |
+|               | 20 users | 23,720 | 23,404 | 23,596 | 23,596 |
+
+### macOS 12, i5 @ 2.9 GHz
+
+- Cheroot 8.3.1 Executed   5,468 activities (~ 18 requests per user per second)
+- Cheroot 8.5.2 Executed  12,596 activities (~ 42 requests per user per second)
+- Cheroot 8.6.0 Executed  12,660 activities (~ 42 requests per user per second)
+
+
 ## 2021-11-09
 > Seems that stressor is the limiting factor
 (MacBook, i5 2,9GHz, macOs 12.0.1, Py3.9)

diff --git a/tests/test_http.py b/tests/test_http.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/tests/test_litmus.py b/tests/test_litmus.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/tests/test_lock_manager.py b/tests/test_lock_manager.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """Unit test for lock_manager.py"""

diff --git a/tests/test_property_manager.py b/tests/test_property_manager.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """Unit test for property_manager.py"""

diff --git a/tests/test_scripted.py b/tests/test_scripted.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/tests/test_streaming.py b/tests/test_streaming.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 

diff --git a/tests/test_util.py b/tests/test_util.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """Unit tests for wsgidav.util"""

diff --git a/tests/test_wsgidav_app.py b/tests/test_wsgidav_app.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/tests/util.py b/tests/util.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/wsgidav/dav_error.py b/wsgidav/dav_error.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/dav_provider.py b/wsgidav/dav_provider.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/dc/base_dc.py b/wsgidav/dc/base_dc.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
 """
 Abstract base class of a domain controller (used by HTTPAuthenticator).

diff --git a/wsgidav/dc/nt_dc.py b/wsgidav/dc/nt_dc.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/wsgidav/dc/pam_dc.py b/wsgidav/dc/pam_dc.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
 """
 Implementation of a domain controller that allows users to authenticate against

diff --git a/wsgidav/dc/simple_dc.py b/wsgidav/dc/simple_dc.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/default_conf.py b/wsgidav/default_conf.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/dir_browser/_dir_browser.py b/wsgidav/dir_browser/_dir_browser.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/wsgidav/error_printer.py b/wsgidav/error_printer.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/fs_dav_provider.py b/wsgidav/fs_dav_provider.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/http_authenticator.py b/wsgidav/http_authenticator.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/lock_man/lock_manager.py b/wsgidav/lock_man/lock_manager.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/lock_man/lock_storage.py b/wsgidav/lock_man/lock_storage.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/lock_man/lock_storage_redis.py b/wsgidav/lock_man/lock_storage_redis.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/mw/cors.py b/wsgidav/mw/cors.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php
 """

diff --git a/wsgidav/mw/debug_filter.py b/wsgidav/mw/debug_filter.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Original PyFileServer (c) 2005 Ho Chun Wei.
 # Licensed under the MIT license:
 # http://www.opensource.org/licenses/mit-license.php

diff --git a/wsgidav/prop_man/couch_property_manager.py b/wsgidav/prop_man/couch_property_manager.py
@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# (c) 2009-2021 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
+# (c) 2009-2022 Martin Wendt and contributors; see WsgiDAV https://github.com/mar10/wsgidav
 # Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
 """
 Implements a property manager based on CouchDB.