Merge pull request #212 from python-babel/v2.1.0

v3.0.0

Author: TkTech

.bumpversion.cfg

@@ -1,8 +1,10 @@
 [bumpversion]
-current_version = 2.0.0
+current_version = 3.0.0
 commit = True
 tag = True
 
-[bumpversion:file:setup.py]
+[bumpversion:file:pyproject.toml]
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
 
 [bumpversion:file:docs/conf.py]

.github/workflows/release.yml

@@ -1,8 +1,7 @@
 on:
-  push:
-    # Sequence of patterns matched against refs/tags
-    tags:
-      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+  release:
+    types:
+      - created
 
 name: Release
 
@@ -21,15 +20,12 @@ jobs:
       with:
         python-version: 3.8
 
-    - name: Install python dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools
-        pip install wheel twine
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
 
     - name: Publishing
       env:
-        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+        PYPI_TOKEN: ${{ secrets.PYPI_PASSWORD }}
       run: |
-        python setup.py sdist bdist_wheel
-        twine upload dist/*
+        poetry config pypi-token.pypi $PYPI_TOKEN
+        poetry publish --build

.github/workflows/test.yml

@@ -10,23 +10,22 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8, 3.9, pypy3.7]
+        python-version: [3.7, 3.8, 3.9, "3.10", "3.11", pypy3.7]
 
     steps:
-      # Python needs to be setup before checkout to prevent files from being
-      # left in the source tree. See setup-python/issues/106.
+    - uses: actions/checkout@v3
+
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
-    - uses: actions/checkout@v3
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
 
-    - name: Installing python dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools
-        pip install -e '.[dev]'
+    - name: Installing
+      run: poetry install --no-interaction
 
     - name: Running tests
       run: |
-        pytest
+        poetry run pytest --cov=flask_babel --cov-report=xml

.gitignore

@@ -8,3 +8,5 @@ docs/_build
 .vscode
 *.code-workspace
 venv
+poetry.lock
+.idea

CHANGELOG

@@ -0,0 +1,16 @@
+v3.0.0
+
+Major version bump as this version removes support for Python 3.5 and 3.6, along with multiple
+major breaking changes. Hope you've been following SemVer :)
+
+- Dropped support for end-of-life Python 3.5 and 3.6, added tests for 3.10 and 3.11.
+- Fixes to documentation to address outdated links and settings (#204, 201)
+- Jinja version 3 or greater is now required (released 2021)
+- Removed Babel._date_formats, use the public Babel.date_formats instead.
+- list_translations() always returns the default locale, even if it does not exist. (#75)
+- Add lazy_npgettext() (#68)
+- Babel.locale_selector and Babel.timezone_selector no longer exist. They must be provided
+  either when the Babel() object is created or when init_app() is called. This is to support
+  having a single Babel object for multiple Flask apps (#107) as well as to simplify settings
+  and multi-threaded state.
+- Most configuration options can be passed directly through init_app().

MANIFEST.in

@@ -3,11 +3,10 @@
 ![Tests](https://github.com/python-babel/flask-babel/workflows/Tests/badge.svg?branch=master)
 [![PyPI](https://img.shields.io/pypi/v/flask-babel.svg?maxAge=2592000)](https://pypi.python.org/pypi/Flask-Babel)
 
-Implements i18n and l10n support for Flask.  This is based on the Python
-[babel][] module as well as [pytz][] both of which are installed automatically
-for you if you install this library.
+Implements i18n and l10n support for Flask. This is based on the Python
+[babel][] and [pytz][] modules.
 
-# Documention
+## Documentation
 
 The latest documentation is available [here][docs].
 

README.md

@@ -22,7 +22,7 @@
 author = 'Armin Ronacher'
 
 # The full version, including alpha/beta/rc tags
-release = '2.0.0'
+release = '3.0.0'
 
 
 # -- General configuration ---------------------------------------------------

docs/conf.py

@@ -17,7 +17,7 @@ Install the extension from PyPi::
     $ pip install Flask-Babel
 
 Please note that Flask-Babel requires Jinja >=2.5.  If you are using an
-older version you will have to upgrade or disable the Jinja support 
+older version you will have to upgrade or disable the Jinja support
 (see configuration).
 
 
@@ -31,13 +31,12 @@ object after configuring the application::
     from flask_babel import Babel
 
     app = Flask(__name__)
-    app.config.from_pyfile('mysettings.cfg')
     babel = Babel(app)
 
-To disable jinja support, include ``configure_jinja=False`` in the Babel 
-constructor call.  The babel object itself can be used to configure the babel support
-further.  Babel has the following configuration values that can be used to
-change some internal defaults:
+To disable jinja support, include ``configure_jinja=False`` in the Babel
+constructor call. The babel object itself can be used to configure the babel
+support further. Babel has the following configuration values that can be used
+to change some internal defaults:
 
 =============================== =============================================
 `BABEL_DEFAULT_LOCALE`          The default locale to use if no locale
@@ -52,10 +51,18 @@ change some internal defaults:
                                 folders. Defaults to ``translations``.
 `BABEL_DOMAIN`                  The message domain used by the application.
                                 Defaults to ``messages``.
+
+                                It can also be a semi-colon (``;``) separated
+                                string of different domains for each of the
+                                translation directories, eg::
+
+                                    BABEL_TRANSLATION_DIRECTORIES=/path/to/translations;/another/path/
+                                    BABEL_DOMAINS=messages;myapp
+
 =============================== =============================================
 
 For more complex applications you might want to have multiple applications
-for different users which is where selector functions come in handy.  The
+for different users which is where selector functions come in handy. The
 first time the babel extension needs the locale (locale code/ID) of the
 current user it will call a :meth:`~Babel.localeselector` function, and
 the first time the timezone is needed it will call a
@@ -71,7 +78,6 @@ Example selector functions::
 
     from flask import g, request
 
-    @babel.localeselector
     def get_locale():
         # if a user is logged in, use the locale from the user settings
         user = getattr(g, 'user', None)
@@ -82,12 +88,14 @@ Example selector functions::
         # example.  The best match wins.
         return request.accept_languages.best_match(['de', 'fr', 'en'])
 
-    @babel.timezoneselector
     def get_timezone():
         user = getattr(g, 'user', None)
         if user is not None:
             return user.timezone
 
+    app = Flask(__name__)
+    babel = Babel(app, locale_selector=get_locale, timezone_selector=get_timezone)
+
 The example above assumes that the current user is stored on the
 :data:`flask.g` object.
 
@@ -256,7 +264,6 @@ this is what you want in there:
 
     [python: **.py]
     [jinja2: **/templates/**.html]
-    extensions=jinja2.ext.autoescape,jinja2.ext.with_
 
 Save it as ``babel.cfg`` or something similar next to your application.
 Then it's time to run the `pybabel` command that comes with Babel to
@@ -392,6 +399,8 @@ Gettext Functions
 
 .. autofunction:: lazy_pgettext
 
+.. autofunction:: lazy_npgettext
+
 Low-Level API
 `````````````