Merge pull request #111 from flask-api/release/v2.0

jacebrowning · web-flow · commit beb2aa4c70da · 2019-11-27T15:09:35.000-05:00
Release v2.0
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,10 @@
+dist: xenial
+
 language: python
 python:
-  - 2.7
-  - 3.4
-  - 3.5
   - 3.6
+  - 3.7
+  - 3.8
 
 cache:
   pip: true
@@ -14,8 +15,7 @@ env:
   global:
     - RANDOM_SEED=0
   matrix:
-    - FLASK_VERSION=0.12.4
-    - FLASK_VERSION=1.0.2
+    - FLASK_VERSION=1.1.1
 
 before_install:
   - pip install pipenv
diff --git a/Pipfile b/Pipfile
@@ -12,7 +12,7 @@ Markdown = "<3"
 [dev-packages]
 
 # Linters
-flake8 = "~=2.1"
+flake8 = "~=3.7.9"
 
 # Testing
 nose = "*"
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Browsable web APIs for Flask.
 
-[![Unix Build Status](https://img.shields.io/travis/flask-api/flask-api.svg)](https://travis-ci.org/flask-api/flask-api) 
+[![Unix Build Status](https://img.shields.io/travis/flask-api/flask-api.svg)](https://travis-ci.org/flask-api/flask-api)
 [![Coverage Status](https://img.shields.io/coveralls/flask-api/flask-api.svg)](https://coveralls.io/r/flask-api/flask-api)
 [![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/flask-api/flask-api.svg)](https://scrutinizer-ci.com/g/flask-api/flask-api/)
 [![PyPI Version](https://img.shields.io/pypi/v/Flask-API.svg)](https://pypi.org/project/Flask-API/)
@@ -19,8 +19,8 @@ Flask API is a drop-in replacement for Flask that provides an implementation of
 
 Requirements:
 
-* Python 2.7+ or 3.4+
-* Flask 0.12.3+
+* Python 3.6+
+* Flask 1.1.+
 
 Install using `pip`:
 
@@ -46,7 +46,7 @@ def example():
     return {'hello': 'world'}
 ```
 
-A renderer for the response data will be selected using content negotiation based on the client 'Accept' header. If you're making the API request from a regular client, this will default to a JSON response. If you're viewing the API in a browser, it'll default to the browsable API HTML. 
+A renderer for the response data will be selected using content negotiation based on the client 'Accept' header. If you're making the API request from a regular client, this will default to a JSON response. If you're viewing the API in a browser, it'll default to the browsable API HTML.
 
 ## Requests
 
@@ -133,8 +133,8 @@ You can now open a new tab and interact with the API from the command line:
 
 ```shell
 $ curl -X GET http://127.0.0.1:5000/
-[{"url": "http://127.0.0.1:5000/0/", "text": "do the shopping"}, 
- {"url": "http://127.0.0.1:5000/1/", "text": "build the codez"}, 
+[{"url": "http://127.0.0.1:5000/0/", "text": "do the shopping"},
+ {"url": "http://127.0.0.1:5000/1/", "text": "build the codez"},
  {"url": "http://127.0.0.1:5000/2/", "text": "paint the door"}]
 
 $ curl -X GET http://127.0.0.1:5000/1/
diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md
@@ -1,5 +1,10 @@
 # Release Notes
 
+## Version 2.0
+
+* Dropped support for Python `<3.6`.
+* Dropped support for Flask `<1.1`.
+
 ## Version 1.1
 
 * Added support for custom JSON encoders.
diff --git a/docs/index.md b/docs/index.md
@@ -14,8 +14,8 @@ Flask API is a drop-in replacement for Flask that provides an implementation of
 
 Requirements:
 
-* Python 2.7+ or 3.4+
-* Flask 0.12.3+
+* Python 3.6+
+* Flask 1.1+
 
 The following packages are optional:
 
@@ -39,7 +39,7 @@ Return any valid response object as normal, or return a `list` or `dict`.
     def example():
         return {'hello': 'world'}
 
-A renderer for the response data will be selected using content negotiation based on the client 'Accept' header. If you're making the API request from a regular client, this will default to a JSON response. If you're viewing the API in a browser it'll default to the browsable API HTML. 
+A renderer for the response data will be selected using content negotiation based on the client 'Accept' header. If you're making the API request from a regular client, this will default to a JSON response. If you're viewing the API in a browser it'll default to the browsable API HTML.
 
 ## Requests
 
@@ -55,23 +55,23 @@ The following example demonstrates a simple API for creating, listing, updating
 
     from flask import request, url_for
     from flask_api import FlaskAPI, status, exceptions
-    
+
     app = FlaskAPI(__name__)
-    
-    
+
+
     notes = {
         0: 'do the shopping',
         1: 'build the codez',
         2: 'paint the door',
     }
-    
+
     def note_repr(key):
         return {
             'url': request.host_url.rstrip('/') + url_for('notes_detail', key=key),
             'text': notes[key]
         }
-    
-    
+
+
     @app.route("/", methods=['GET', 'POST'])
     def notes_list():
         """
@@ -82,11 +82,11 @@ The following example demonstrates a simple API for creating, listing, updating
             idx = max(notes.keys()) + 1
             notes[idx] = note
             return note_repr(idx), status.HTTP_201_CREATED
-    
+
         # request.method == 'GET'
         return [note_repr(idx) for idx in sorted(notes.keys())]
-    
-    
+
+
     @app.route("/<int:key>/", methods=['GET', 'PUT', 'DELETE'])
     def notes_detail(key):
         """
@@ -96,17 +96,17 @@ The following example demonstrates a simple API for creating, listing, updating
             note = str(request.data.get('text', ''))
             notes[key] = note
             return note_repr(key)
-    
+
         elif request.method == 'DELETE':
             notes.pop(key, None)
             return '', status.HTTP_204_NO_CONTENT
-    
+
         # request.method == 'GET'
         if key not in notes:
             raise exceptions.NotFound()
         return note_repr(key)
-    
-    
+
+
     if __name__ == "__main__":
         app.run(debug=True)
 
diff --git a/flask_api/__init__.py b/flask_api/__init__.py
@@ -1,3 +1,3 @@
 from flask_api.app import FlaskAPI
 
-__version__ = '1.1'
+__version__ = '2.0'
diff --git a/flask_api/mediatypes.py b/flask_api/mediatypes.py
@@ -88,8 +88,7 @@ def __hash__(self):
     def __eq__(self, other):
         # Compare two MediaType instances, ignoring parameter ordering.
         return (
-            self.full_type == other.full_type and
-            self.params == other.params
+            self.full_type == other.full_type and self.params == other.params
         )
 
 
diff --git a/flask_api/request.py b/flask_api/request.py
@@ -51,11 +51,11 @@ def _parse(self):
         try:
             parser, media_type = negotiator.select_parser(parsers)
             ret = parser.parse(self.stream, media_type, **options)
-        except:
+        except Exception as e:
             # Ensure that accessing `request.data` again does not reraise
             # the exception, so that eg exceptions can handle properly.
             self._set_empty_data()
-            raise
+            raise e from None
 
         if parser.handles_file_uploads:
             assert isinstance(ret, tuple) and len(ret) == 2, 'Expected a two-tuple of (data, files)'
diff --git a/flask_api/status.py b/flask_api/status.py
@@ -67,6 +67,7 @@ def is_server_error(code):
 HTTP_415_UNSUPPORTED_MEDIA_TYPE = 415
 HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE = 416
 HTTP_417_EXPECTATION_FAILED = 417
+HTTP_418_IM_A_TEAPOT = 418
 HTTP_428_PRECONDITION_REQUIRED = 428
 HTTP_429_TOO_MANY_REQUESTS = 429
 HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE = 431
diff --git a/setup.py b/setup.py
@@ -15,9 +15,7 @@
 author = 'Tom Christie'
 author_email = 'tom@tomchristie.com'
 license = 'BSD'
-install_requires = [
-    'Flask >= 0.12.3',
-]
+install_requires = ['Flask >= 1.1']
 
 long_description = """Browsable web APIs for Flask."""
 
@@ -75,12 +73,10 @@ def get_package_data(package):
         'Natural Language :: English',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 2',
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
         'Topic :: Internet :: WWW/HTTP',
     ]
 )

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`from flask_api.app import FlaskAPI`
`2`	`2`
`3`		`-__version__ = '1.1'`
	`3`	`+__version__ = '2.0'`
Original file line number	Diff line number	Diff line change
`@@ -88,8 +88,7 @@ def __hash__(self):`
`88`	`88`	`def __eq__(self, other):`
`89`	`89`	`# Compare two MediaType instances, ignoring parameter ordering.`
`90`	`90`	`return (`
`91`		`- self.full_type == other.full_type and`
`92`		`- self.params == other.params`
	`91`	`+ self.full_type == other.full_type and self.params == other.params`
`93`	`92`	`)`
`94`	`93`
`95`	`94`