OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Switched info plugin to importlib to mitigate deprecations

Browse Source
This commit is contained in:
squidfunk 2023-08-10 13:45:51 +02:00
parent 15c024cbbf
commit 0be6172765
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF
2 changed files with 18 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
material/plugins/info/plugin.py
View File

@ -26,11 +26,11 @@ import requests
import sys import sys
from colorama import Fore, Style from colorama import Fore, Style
from importlib.metadata import distributions, version
from io import BytesIO from io import BytesIO
from mkdocs import utils from mkdocs import utils
from mkdocs.plugins import BasePlugin, event_priority from mkdocs.plugins import BasePlugin, event_priority
from mkdocs.structure.files import get_files from mkdocs.structure.files import get_files
from pkg_resources import get_distribution, working_set
from zipfile import ZipFile, ZIP_DEFLATED from zipfile import ZipFile, ZIP_DEFLATED
from material.plugins.info.config import InfoConfig from material.plugins.info.config import InfoConfig
@ -70,11 +70,11 @@ class InfoPlugin(BasePlugin[InfoConfig]):
res = requests.get(url, allow_redirects = False) res = requests.get(url, allow_redirects = False)
# Check if we're running the latest version # Check if we're running the latest version
_, version = res.headers.get("location").rsplit("/", 1) _, current = res.headers.get("location").rsplit("/", 1)
package = get_distribution("mkdocs-material") present = version("mkdocs-material")
if not package.version.startswith(version): if not present.startswith(current):
log.error("Please upgrade to the latest version.") log.error("Please upgrade to the latest version.")
self._help_on_versions_and_exit(package.version, version) self._help_on_versions_and_exit(present, current)
# Print message that we're creating a bug report # Print message that we're creating a bug report
log.info("Started archive creation for bug report") log.info("Started archive creation for bug report")
@ -116,7 +116,10 @@ class InfoPlugin(BasePlugin[InfoConfig]):
f.writestr( f.writestr(
os.path.join(archive_name, "requirements.lock.txt"), os.path.join(archive_name, "requirements.lock.txt"),
"\n".join(sorted([ "\n".join(sorted([
f"{dist.as_requirement()}" for dist in working_set "==".join([
package.name,
package.version
]) for package in distributions()
])) ]))
) )

15
src/plugins/info/plugin.py
View File

@ -26,11 +26,11 @@ import requests
import sys import sys
from colorama import Fore, Style from colorama import Fore, Style
from importlib.metadata import distributions, version
from io import BytesIO from io import BytesIO
from mkdocs import utils from mkdocs import utils
from mkdocs.plugins import BasePlugin, event_priority from mkdocs.plugins import BasePlugin, event_priority
from mkdocs.structure.files import get_files from mkdocs.structure.files import get_files
from pkg_resources import get_distribution, working_set
from zipfile import ZipFile, ZIP_DEFLATED from zipfile import ZipFile, ZIP_DEFLATED
from material.plugins.info.config import InfoConfig from material.plugins.info.config import InfoConfig
@ -70,11 +70,11 @@ class InfoPlugin(BasePlugin[InfoConfig]):
res = requests.get(url, allow_redirects = False) res = requests.get(url, allow_redirects = False)
# Check if we're running the latest version # Check if we're running the latest version
_, version = res.headers.get("location").rsplit("/", 1) _, current = res.headers.get("location").rsplit("/", 1)
package = get_distribution("mkdocs-material") present = version("mkdocs-material")
if not package.version.startswith(version): if not present.startswith(current):
log.error("Please upgrade to the latest version.") log.error("Please upgrade to the latest version.")
self._help_on_versions_and_exit(package.version, version) self._help_on_versions_and_exit(present, current)
# Print message that we're creating a bug report # Print message that we're creating a bug report
log.info("Started archive creation for bug report") log.info("Started archive creation for bug report")
@ -116,7 +116,10 @@ class InfoPlugin(BasePlugin[InfoConfig]):
f.writestr( f.writestr(
os.path.join(archive_name, "requirements.lock.txt"), os.path.join(archive_name, "requirements.lock.txt"),
"\n".join(sorted([ "\n".join(sorted([
f"{dist.as_requirement()}" for dist in working_set "==".join([
package.name,
package.version
]) for package in distributions()
])) ]))
) )