mirror of
https://github.com/certbot/certbot.git
synced 2026-07-28 08:45:22 +02:00
Adrien FerrandandBrad Warren
d5de24d9fc
This PR is the second part of #6497 to ease the integration, following the new plan propose by @bmw here: #6497 (comment) This PR creates the module certbot.compat.os, that delegates everything to os, and that will be the safeguard against problematic methods of the standard module. On top of that, a quality check wrapper is called in the lint tox environment. This wrapper calls pylint and ensures that standard os module is no used directly in the certbot codebase. Finally local oldest requirements are updated to ensure that tests will take the new logic when running. * Add executable permissions * Add the delegate certbot.compat.os module, add check coding style to enforce usage of certbot.compat.os instead of standard os * Load certbot.compat.os instead of os * Move existing compat test * Update local oldest requirements * Import sys * Update account_test.py * Update os.py * Update os.py * Update local oldest requirements * Implement the new linter_plugin * Fix local oldest for nginx * Remove check coding style * Update linter_plugin.py * Add several comments * Update the setup.py * Add documentation * Update acme dependencies * Update certbot/compat/os.py * Update docs/contributing.rst * Update linter_plugin.py * Handle os.path. Simplify checker. * Add a comment to a reference implementation * Update changelog * Fix module registering * Update docs/contributing.rst * Update config and changelog
32 lines
1.7 KiB
Python
32 lines
1.7 KiB
Python
"""
|
|
This compat modules is a wrapper of the core os module that forbids usage of specific operations
|
|
(eg. chown, chmod, getuid) that would be harmful to the Windows file security model of Certbot.
|
|
This module is intended to replace standard os module throughout certbot projects (except acme).
|
|
"""
|
|
from __future__ import absolute_import
|
|
|
|
# First round of wrapping: we import statically all public attributes exposed by the os module
|
|
# This allows in particular to have pylint, mypy, IDEs be aware that most of os members are
|
|
# available in certbot.compat.os.
|
|
from os import * # type: ignore # pylint: disable=wildcard-import,unused-wildcard-import,redefined-builtin,os-module-forbidden
|
|
|
|
# Second round of wrapping: we import dynamically all attributes from the os module that have not
|
|
# yet been imported by the first round (static import). This covers in particular the case of
|
|
# specific python 3.x versions where not all public attributes are in the special __all__ of os,
|
|
# and so not in `from os import *`.
|
|
import os as std_os # pylint: disable=os-module-forbidden
|
|
import sys as std_sys
|
|
ourselves = std_sys.modules[__name__]
|
|
for attribute in dir(std_os):
|
|
# Check if the attribute does not already exist in our module. It could be internal attributes
|
|
# of the module (__name__, __doc__), or attributes from standard os already imported with
|
|
# `from os import *`.
|
|
if not hasattr(ourselves, attribute):
|
|
setattr(ourselves, attribute, getattr(std_os, attribute))
|
|
|
|
# Similar to os.path, allow certbot.compat.os.path to behave as a module
|
|
std_sys.modules[__name__ + '.path'] = path
|
|
|
|
# Clean all remaining importables that are not from the core os module.
|
|
del ourselves, std_os, std_sys
|