Version 12.0.0 (#1451)

lk-geimfari · Jan 7, 2024 · be7354f · be7354f
1 parent a202587
commit be7354f
Show file tree

Hide file tree

Showing 77 changed files with 5,404 additions and 2,182 deletions.
diff --git a/.github/labeler.yml b/.github/labeler.yml
diff --git a/.github/workflows/labeler.yml b/.github/workflows/labeler.yml
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8.x
+          python-version: 3.10.x
       - name: Upgrade pip
         run: pip install --upgrade --user pip
       - name: Install Poetry

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,7 +14,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.10', '3.11', '3.12']
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
@@ -50,7 +50,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['pypy3.8', 'pypy3.9', 'pypy3.10']
+        python-version: ['pypy3.10']
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -3,7 +3,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.10"
 
 sphinx:
   configuration: docs/conf.py

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,9 +1,23 @@
-Version 11.1.0
+Version 12.0.0
 --------------
 
-**Added**:
-
-- Added validation for custom field names.
+- Python 3.8 and 3.9 are no longer supported.
+- Added support for field aliases. See docs for more information.
+- Added method ``calver`` for ``Development``.
+- Added method ``stage`` for ``Development``.
+- Added method ``country_emoji_flag`` for ``Address``.
+- Removed method ``hashtags`` of the ``Internet`` provider. Use method ``words`` of the ``Text`` provider instead.
+- Removed parameter ``providers`` for ``Field`` and ``Fieldset``. Use custom field handlers instead.
+- Removed parameters ``pre_release`` and ``calver`` for ``Development.version``. Use methods ``stage`` and ``calver`` instead.
+- Moved method ``emoji`` of the ``Internet`` provider to the ``Text`` provider.
+- Moved method ``dsn`` of the ``Development`` provider to the ``Internet`` provider.
+- The ``Text().emoji()`` method now supports the ``category`` parameter and ``EmojiCategory`` enum. Also it return emoji instead of emoji shortcut string.
+- Added decorator ``@handle`` for ``Field`` and ``Fieldset`` to register custom fields.
+- Renamed ``register_field`` to ``register_handler`` for `Field` and `Fieldset`.
+- Renamed ``register_fields`` to ``register_handlers`` for `Field` and `Fieldset`.
+- Renamed ``unregister_field`` to ``unregister_handler`` for `Field` and `Fieldset`.
+- Renamed ``unregister_fields`` to ``unregister_handlers`` for `Field` and `Fieldset`.
+- Renamed ``unregister_all_fields`` to ``unregister_all_handlers`` for `Field` and `Fieldset`.
 
 
 Version 11.0.0

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-Present Isaak Uchakaev (Likid Geimfari) <likid.geimfari@gmail.com>
+Copyright (c) 2016-Present Isaak Uchakaev (Likid Geimfari) <hey@isaak.dev>
 
 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/README.rst b/README.rst
@@ -31,7 +31,7 @@ Description
      :target: https://pypi.org/project/mimesis/
      :alt: PyPI - Downloads
 
-.. image:: https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12%20%7C%20pypy-brightgreen
+.. image:: https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%20pypy-brightgreen
      :target: https://pypi.org/project/mimesis/
      :alt: Python version
 

diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -5,6 +5,16 @@ pre, tt, code {
     font-size: 0.9em;
 }
 
+a.reference {
+    text-decoration: none;
+    border-bottom: none;
+}
+
+div.sphinxsidebar a {
+    text-decoration: none;
+    border-bottom: none;
+}
+
 .function, .method, .class, .exception {
     padding-bottom: 15px;
 }
@@ -32,7 +42,7 @@ div.note {
 }
 
 div.warning {
-    border-radius: 10px;
+    border-radius: 8px;
 }
 
 pre, div[class*="highlight-"] {
@@ -42,7 +52,7 @@ pre, div[class*="highlight-"] {
 
 div.highlight pre, table.highlighttable pre {
     margin: 0;
-    border-radius: 10px !important;
+    border-radius: 5px !important;
     padding: 20px !important;
 }
 
@@ -52,29 +62,29 @@ div.highlight pre, table.highlighttable pre {
 
 @media (prefers-color-scheme: dark) {
     body {
-        background-color: #21272E;
+        background-color: #171717;
     }
 
     div.sphinxsidebar p {
-        color: #adbac7;
+        color: #98a3ad;
     }
 
     div.sphinxsidebar a {
-        color: #adbac7;
+        color: #98a3ad;
         border-bottom: none;
     }
 
     dt:target, .highlight {
-        background: #21272E;
+        background: #171717;
     }
 
     .py, .py-class {
-        background: #21272E;
+        background: #171717;
     }
 
     div.sphinxsidebar h3,
     div.sphinxsidebar h4 {
-        color: #adbac7;
+        color: #98a3ad;
     }
 
     div.sphinxsidebar a:hover {
@@ -83,48 +93,67 @@ div.highlight pre, table.highlighttable pre {
     }
 
     div.sphinxsidebar h3 a {
-        color: #adbac7;
+        color: #98a3ad;
     }
 
     div.sphinxsidebar ul {
-        color: #adbac7;
+        color: #98a3ad;
     }
 
     div.body {
-        background-color: #21272E;
-        color: #adbac7;
+        background-color: #171717;
+        color: #98a3ad;
     }
 
     div.note {
-        background-color: #2d333b !important;
+        background-color: #1a1a1a !important;
         border-radius: 10px;
-        border: 1px solid hsla(203.9, 85.8%, 52.9%, 0.43);
+        border: 1px solid #2a2e2f;
     }
 
     pre {
-        background-color: #2d333b !important;
+        background-color: #1a1a1a !important;
         border-radius: 10px;
     }
 
     tt, code {
-        background-color: #2d333b !important;
-        color: #adbac7;
+        background-color: #201f1f !important;
+        color: #98a3ad;
+        border-bottom: none;
+        padding: 1px 4px;
+        border-radius: 3px;
     }
 
     #api-reference .reference span.pre {
-        background-color: #21272E;
-    !important;
+        background-color: #171717 !important;
     }
 
     div.highlight {
-        background-color: #2d333b !important;
+        background-color: #1a1a1a !important;
         border-radius: 15px;
     }
 
     div.warning {
-        background-color: #2d333b !important;
-        border-radius: 10px;
-        border: 1px solid rgba(255, 170, 0, 0.25)
+        background-color: #1a1a1a !important;
+        border-radius: 8px;
+        border: 1px solid rgba(142, 117, 114, 0.25);
+    }
+
+    #contents li a,
+    #api-reference li a,
+    #additional-information li a,
+    #changelog li a,
+    #indices li a {
+        color: #98a3ad !important;
+    }
+
+    #contents li a:hover,
+    #api-reference li a:hover,
+    #additional-information li a:hover,
+    #changelog li a:hover,
+    #indices li a:hover {
+        color: #2b79a2 !important;
+        text-decoration: underline !important;
     }
 
     table.docutils {
@@ -137,18 +166,25 @@ div.highlight pre, table.highlighttable pre {
     tt.xref, code.xref, a tt {
         background-color: #FBFBFB;
         border-bottom: none;
+        padding: 1px 4px;
+        border-radius: 3px;
+    }
+
+    div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
+        border-bottom: none !important;
     }
 
     a {
-        color: #539bf5;
+        color: #2b79a2;
         border-bottom: none;
     }
 
     a:hover {
-        color: #539bf5;
-        text-decoration: underline;
+        color: #2b79a2;
+        text-decoration: underline !important;
     }
 
+
     a.reference {
         border-bottom: none !important;
     }
@@ -193,7 +229,7 @@ div.highlight pre, table.highlighttable pre {
     }
 
     .highlight .nn {
-        color: #adbac7;
+        color: #98a3ad;
         font-weight: bold;
     }
 
@@ -219,16 +255,16 @@ div.highlight pre, table.highlighttable pre {
     }
 
     .rst-versions .rst-current-version {
-        background-color: #21272E !important;
-        border: 1px solid #2d333b;
+        background-color: #171717 !important;
+        border: 1px solid #1a1a1a;
     }
 
     .highlight .nf {
         color: #dcbdfb;
     }
 
     .highlight .bp {
-        color: #adbac7;
+        color: #98a3ad;
     }
 
     .highlight .nc {
@@ -241,7 +277,7 @@ div.highlight pre, table.highlighttable pre {
     }
 
     .highlight .nd {
-        color: #adbac7;
+        color: #98a3ad;
         font-weight: normal;
     }
 
@@ -254,21 +290,21 @@ div.highlight pre, table.highlighttable pre {
         width: 80%;
         padding: 0.25em;
         box-sizing: border-box;
-        background: #21272E;
+        background: #171717;
     }
 
     div.sphinxsidebar input {
         border: 1px solid #3E4348;
-        color: #ADBAC7;
+        color: #98a3ad;
     }
 
     div.sphinxsidebar #searchbox input[type="submit"] {
-        color: #ADBAC7;
-        background: #21272E;
+        color: #98a3ad;
+        background: #171717;
     }
 
     input[value="Go"] {
-        background-color: #21272E !important;
+        background-color: #171717 !important;
     }
 
     input[value="Go"]:hover {
@@ -285,7 +321,7 @@ div.highlight pre, table.highlighttable pre {
     }
 
     a.headerlink:hover {
-        color: #adbac7 !important;
+        color: #98a3ad !important;
         background: transparent !important;
         text-decoration: none !important;
     }

diff --git a/docs/_static/octopus-dark.svg b/docs/_static/octopus-dark.svg
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -40,7 +40,7 @@
 
   const color = "#2d333b"
   const prefersDarkMode = window.matchMedia('(prefers-color-scheme: dark)').matches
-  const backgroundColor = prefersDarkMode ? '#2d333b' : 'hsl(0, 0%, 21%)';
+  const backgroundColor = prefersDarkMode ? '#1c1f20' : 'hsl(0, 0%, 21%)';
 
   addBackToTop({
     diameter: 45,

diff --git a/docs/_templates/sidebars/follow_me.html b/docs/_templates/sidebars/follow_me.html
diff --git a/docs/_templates/sidebars/head.html b/docs/_templates/sidebars/head.html