pywebutil 1.0__py3-none-any.whl

pywebutil-1.0.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: pywebutil
+Version: 1.0
+Summary: Common utilities and handler code for Python web apps
+Author-email: Ryan Barrett <webutil@ryanb.org>
+Project-URL: Homepage, https://github.com/snarfed/webutil
+Project-URL: Documentation, https://oauth-dropins.readthedocs.io/en/latest/source/oauth_dropins.webutil.html
+Keywords: App Engine,Flask,HTTP,web,utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: Public Domain
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cachetools>=3.1
+Requires-Dist: cryptography
+Requires-Dist: domain2idna>=1.12
+Requires-Dist: Flask>=2.0
+Requires-Dist: humanize==4.12.0
+Requires-Dist: requests>=2.0
+Requires-Dist: requests-hardened>=1.0
+Requires-Dist: werkzeug
+Provides-Extra: tests
+Requires-Dist: mox3<2.0,>=0.28; extra == "tests"
+Requires-Dist: flask-caching; extra == "tests"
+Requires-Dist: httplib2; extra == "tests"
+Requires-Dist: lxml; extra == "tests"
+Requires-Dist: mf2py; extra == "tests"
+Requires-Dist: oauthlib; extra == "tests"
+Requires-Dist: prawcore; extra == "tests"
+Requires-Dist: python-tumblpy; extra == "tests"
+Requires-Dist: tweepy; extra == "tests"
+Requires-Dist: ujson; extra == "tests"
+Requires-Dist: urllib3; extra == "tests"
+Requires-Dist: webob; extra == "tests"
+Requires-Dist: websockets; extra == "tests"
+Provides-Extra: html
+Requires-Dist: beautifulsoup4>=4.8; extra == "html"
+Requires-Dist: mf2util>=0.5.0; extra == "html"
+Provides-Extra: google-cloud
+Requires-Dist: google-api-python-client; extra == "google-cloud"
+Requires-Dist: google-cloud-logging>=3.0.0; extra == "google-cloud"
+Requires-Dist: google-cloud-ndb>=2.0; extra == "google-cloud"
+Dynamic: license-file
+
+webutil [![Circle CI](https://circleci.com/gh/snarfed/oauth-dropins.svg?style=svg)](https://circleci.com/gh/snarfed/oauth-dropins) [![Coverage Status](https://coveralls.io/repos/github/snarfed/oauth-dropins/badge.svg?branch=master)](https://coveralls.io/github/snarfed/oauth-dropins?branch=master)
+===
+
+Common utilities and handler code for Python web apps:
+* [`flask_util`](https://oauth-dropins.readthedocs.io/en/stable/source/oauth_dropins.webutil.html#module-oauth_dropins.webutil.flask_util): [Flask](https://flask.palletsprojects.com/) decorators and handlers for caching, exception handling, regular expression URL routing, domain-wide redirects, rate limiting, headers, and serving XRD and JRD templates.
+* [`logs`](https://oauth-dropins.readthedocs.io/en/stable/source/oauth_dropins.webutil.html#module-oauth_dropins.webutil.logs): Flask request handler that collects full trace logs from [Google Cloud Logging](https://cloud.google.com/logging/docs), formats them nicely, and serves them
+* [`models`](https://oauth-dropins.readthedocs.io/en/stable/source/oauth_dropins.webutil.html#module-oauth_dropins.webutil.models): minor utility [Model classes](https://googleapis.dev/python/python-ndb/latest/model.html) for the [Google Cloud Datastore](https://console.cloud.google.com/datastore/) [ndb library](https://github.com/googleapis/python-ndb)
+* [`testutil`](https://oauth-dropins.readthedocs.io/en/stable/source/oauth_dropins.webutil.html#module-oauth_dropins.webutil.testutil): misc utilities and helpers for [unittest](https://docs.python.org/3.9/library/unittest.html), [mox](https://pypi.org/project/mox3/), [requests](http://python-requests.org), and [urllib](https://docs.python.org/3.9/library/urllib.html)
+* [`util`](https://oauth-dropins.readthedocs.io/en/stable/source/oauth_dropins.webutil.html#module-oauth_dropins.webutil.util): wide variety of utilities for data structures, web code, etc.
+* [`webmention`](https://oauth-dropins.readthedocs.io/en/stable/source/oauth_dropins.webutil.html#module-oauth_dropins.webutil.webmention): [Webmention](https://webmention.net/) endpoint discovery and sending
+
+webutil is not (yet) developed, maintained, or distributed as a standalone package. Instead, it's distributed as part of the [oauth-dropins](https://oauth-dropins.readthedocs.io/) library.
+
+* Install with `pip install oauth-dropins`.
+* Supports Python 3.7+.
+* [Reference documentation.](https://oauth-dropins.readthedocs.io/en/stable/source/oauth_dropins.webutil.html)
+
+webutil is dedicated to the public domain. You may also use it under the [CC0 public domain dedication](https://creativecommons.org/share-your-work/public-domain/cc0/).

pywebutil-1.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+pywebutil-1.0.dist-info/licenses/LICENSE,sha256=ogEPNDSH0_dhiv_lT3ifVIdgIzHAqNA_SemnxUfPBJk,7048
+webutil/__init__.py,sha256=tUZ4GRJHWYMLc-1Foo_v9exmw91S4ysjFKW1orAHu5Y,1041
+webutil/appengine_config.py,sha256=tkEq8yDnA8KQIxZUIqLjB7w3KCkKWNx5-oyEJKMzNiI,2900
+webutil/appengine_info.py,sha256=qEgLwmdKEwTr3fEfqGb9bwGqHOIe_3rolgkuojYvTqQ,1192
+webutil/flask_util.py,sha256=QojOPqPM25DAk419uRkeRD_y3MGA3oFe_mFaeQnnePw,18578
+webutil/instance_info.py,sha256=K9J4VLoTHVo_AMkKQ5Zdu5mU9w-JCsDsY7XijU3tTP4,2089
+webutil/logs.py,sha256=Y90W9iuUFlt46IC5YrO55hxIsC4SVaIC21wuZhl9coI,8797
+webutil/models.py,sha256=A51m77ZzgFb9s4_ebh_W2iI5PnheJm9JDA-AmdGbECc,8767
+webutil/testutil.py,sha256=v1i15zHgz9c0OPGqNDzl26C4hHO4Kx7ROlNQsdqExRg,18984
+webutil/util.py,sha256=eWKmtKtPKXh3T4a7MEJd3YPC7RCo2fkjfOl2ck5jKDM,80488
+webutil/webmention.py,sha256=VW8cSTdupCkGXFbq6j2tW87ecOEOjm1zecKc63a89MU,4249
+webutil/templates/instance_info.html,sha256=blZBi4jedWRF5-uK-qAYFxMxzgl69dKEnoM_CCjMnB4,939
+webutil/tests/__init__.py,sha256=gAGzmjiyHjr3xxFAJDz6gLP8GyRwKmeXaqYhYsOCZGQ,1042
+webutil/tests/test_flask_util.py,sha256=dskKiabnvX4haLjxqmzmxYf0UbrLx7rvH0issXTMzb4,13483
+webutil/tests/test_handler_get.tmpl,sha256=IOaB5HfpLw7afAtgRxwH_2EdVUcs1DuQ4heqflS3Khw,38
+webutil/tests/test_handler_template.jrd,sha256=vqlRHLmCqfP-NG1SpKf_bdPYgg46Vwvc9eQ6fbAqmIw,23
+webutil/tests/test_handler_template.xrd,sha256=VtmaiFeHRlP3aHu3zP9o0MsVe0eRGaZiIGOwyEly08A,32
+webutil/tests/test_logs.py,sha256=H9LdXWZusAJADvyCaaxKTqTXV9mKPW55Oc32CABwX1I,2161
+webutil/tests/test_models.py,sha256=w94_v_NedDFCJTOWatOcbay2MffM0K3gGWqvW5V4j_I,7343
+webutil/tests/test_util.py,sha256=tc0OkDFk1adwPrPY8yZr6uaXjMKlQDr_X3VEdW35B7k,79674
+webutil/tests/test_webmention.py,sha256=atAoVvQnqF1rEttklWWRtbh66-M8s5agLi-z18UFBtI,6722
+pywebutil-1.0.dist-info/METADATA,sha256=C1N_qHMf0t3Cz3GLAO-Z3R-VM_1hG4zpds3WsBobg5A,4608
+pywebutil-1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pywebutil-1.0.dist-info/top_level.txt,sha256=Z39zkn_esVcLWjZV3vhCW0IwiglH72mF43_SW1DPAy4,8
+pywebutil-1.0.dist-info/RECORD,,

pywebutil-1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pywebutil-1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

pywebutil-1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+webutil

webutil/__init__.py

@@ -0,0 +1,28 @@
+import io, logging, os, sys
+
+from .appengine_info import DEBUG
+
+assert DEBUG
+creds = os.getenv('GOOGLE_APPLICATION_CREDENTIALS')
+assert not creds or creds.endswith('fake_user_account.json')
+
+logging.getLogger('chardet').setLevel(logging.INFO)
+logging.getLogger('google.cloud').setLevel(logging.INFO)
+logging.getLogger('negotiator').setLevel(logging.WARNING)
+logging.getLogger('urllib3').setLevel(logging.INFO)
+
+# Piggyback on unittest's -v and -q flags to show/hide logging.
+logging.basicConfig()
+if '-v' in sys.argv:
+  logging.getLogger().setLevel(logging.DEBUG)
+else:
+  # used to be:
+  #   elif 'discover' in sys.argv or '-q' in sys.argv or '--quiet' in sys.argv:
+  # dropped that to suppress logging when running full single test files
+
+  # don't emit logs. do this instead of setLevel() or disable() so that the log
+  # messages still get evaluated and raise the same exceptions that they would if
+  # they got emitted.
+  handler = logging.getLogger().handlers[0]
+  if hasattr(handler, 'setStream'):
+    handler.setStream(io.StringIO())

webutil/appengine_config.py

@@ -0,0 +1,83 @@
+"""App Engine config. local vs prod, logging, Google API clients, etc."""
+import logging
+import os
+import threading
+
+from .appengine_info import DEBUG, LOCAL_SERVER
+
+# Use lxml for BeautifulSoup explicitly.
+from . import util
+util.beautifulsoup_parser = 'lxml'
+
+thread_local = threading.local()
+
+# make oauthlib let us use non-SSL http://localhost when running locally
+# https://oauthlib.readthedocs.io/en/latest/oauth2/security.html#envvar-OAUTHLIB_INSECURE_TRANSPORT
+os.environ['OAUTHLIB_INSECURE_TRANSPORT'] = 'true'
+
+#
+# Google API clients
+#
+if DEBUG:
+  os.environ['GOOGLE_APPLICATION_CREDENTIALS'] = os.path.join(
+    os.path.dirname(__file__), 'fake_user_account.json')
+  os.environ.setdefault('CLOUDSDK_CORE_PROJECT', 'app')
+  os.environ.setdefault('DATASTORE_DATASET', 'app')
+  os.environ.setdefault('GOOGLE_CLOUD_PROJECT', 'app')
+  os.environ.setdefault('DATASTORE_EMULATOR_HOST', 'localhost:8089')
+
+# NDB (Cloud Datastore)
+try:
+  # https://googleapis.dev/python/python-ndb/latest/migrating.html#setting-up-a-connection
+  from google.cloud import ndb
+  db = os.environ.get('DATASTORE_DB')
+  ndb_client = thread_local.ndb_client = \
+    ndb.Client(database=db) if db else ndb.Client()
+except ImportError:
+  pass
+
+# Tasks
+# https://docs.cloud.google.com/python/docs/reference/cloudtasks/latest/google.cloud.tasks_v2.services.cloud_tasks.CloudTasksClient
+try:
+  from google.cloud import tasks_v2
+  tasks_client = tasks_v2.CloudTasksClient()
+  if DEBUG or LOCAL_SERVER:
+    tasks_client.host = 'localhost:9999'
+    tasks_client.secure = False
+except ImportError:
+  pass
+
+# Error Reporting
+# https://docs.cloud.google.com/python/docs/reference/clouderrorreporting/latest/client
+try:
+  from google.cloud import error_reporting
+  error_reporting_client = error_reporting.Client()
+  if DEBUG or LOCAL_SERVER:
+    error_reporting_client.host = 'localhost:9999'
+    error_reporting_client.secure = False
+except ImportError:
+  pass
+
+# needed to make logging visible locally under flask run, etc
+logging.basicConfig()
+logging.getLogger().setLevel(logging.DEBUG)
+
+# Logging
+# https://docs.cloud.google.com/python/docs/reference/logging/latest/google.cloud.logging_v2.client.Client
+try:
+  import google.cloud.logging
+  logging_client = thread_local.logging_client = None
+
+  if not DEBUG and not LOCAL_SERVER:
+    logging_client = thread_local.logging_client = Nonegoogle.cloud.logging.Client()
+    logging_client.setup_logging(log_level=logging.DEBUG)
+    # this currently occasionally hits the 256KB batch limit and
+    # crashes in the background service. i've tried batch_size=1 and
+    # SyncTransport, but no luck, same thing.
+    # https://stackoverflow.com/questions/59398479
+except ImportError:
+  pass
+
+for logger in ('charset_normalizer', 'google.cloud', 'oauthlib', 'requests',
+               'requests_cache', 'requests_oauthlib', 'urllib3'):
+  logging.getLogger(logger).setLevel(logging.INFO)

webutil/appengine_info.py

@@ -0,0 +1,32 @@
+"""HTTP request and server information derived from the environment.
+
+App Engine:
+* https://cloud.google.com/appengine/docs/standard/python3/runtime#environment_variables
+* https://cloud.google.com/appengine/docs/flexible/python/runtime#environment_variables
+
+WSGI: https://www.python.org/dev/peps/pep-3333/
+
+To run against the prod datastore, make a service account, download its JSON
+credentials file, then run eg:
+
+env GOOGLE_APPLICATION_CREDENTIALS=service_account_creds.json FLASK_ENV=development flask run -p 8080
+"""
+import os, sys
+
+PROJECT = os.getenv('GOOGLE_CLOUD_PROJECT') or os.getenv('GAE_APPLICATION') or ''
+APP_ID = PROJECT.split('~')[-1]
+
+creds = os.getenv('GOOGLE_APPLICATION_CREDENTIALS')
+gae_env = os.environ.get('GAE_ENV')  # App Engine Standard
+gae_instance = 'GAE_INSTANCE' in os.environ  # App Engine Flex
+
+READ_ONLY = bool(os.environ.get('READ_ONLY'))
+
+args = ' '.join(sys.argv)
+TESTING = 'unittest' in args or 'pytest' in args
+if creds and not creds.endswith('fake_user_account.json'):
+  DEBUG = False
+  LOCAL_SERVER = True
+else:
+  DEBUG = gae_env in (None, 'localdev') and not gae_instance
+  LOCAL_SERVER = gae_env != 'standard' and not gae_instance and not TESTING