NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-07-27 10:58:37 -06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Merge branch 'feature' into 9856-strawberry-2

Browse Source
This commit is contained in:
Arthur 2024-01-03 15:33:08 -08:00
commit 40a7fb6111
19 changed files with 21 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/ci.yml vendored
View File

@ -9,7 +9,7 @@ jobs:
NETBOX_CONFIGURATION: netbox.configuration_testing
strategy:
matrix:
python-version: ['3.8', '3.9', '3.10', '3.11']
python-version: ['3.10', '3.11']
node-version: ['14.x']
services:
redis:

2
docs/development/getting-started.md
View File

@ -7,7 +7,7 @@ Getting started with NetBox development is pretty straightforward, and should fe
* A Linux system or compatible environment
* A PostgreSQL server, which can be installed locally [per the documentation](../installation/1-postgresql.md)
* A Redis server, which can also be [installed locally](../installation/2-redis.md)
* Python 3.8 or later
* Python 3.10 or later
### 1. Fork the Repo

10
docs/installation/3-netbox.md
View File

@ -6,8 +6,8 @@ This section of the documentation discusses installing and configuring the NetBo
Begin by installing all system packages required by NetBox and its dependencies.
!!! warning "Python 3.8 or later required"
NetBox requires Python 3.8, 3.9, 3.10 or 3.11.
!!! warning "Python 3.10 or later required"
NetBox requires Python 3.10 or 3.11.
=== "Ubuntu"
@ -21,7 +21,7 @@ Begin by installing all system packages required by NetBox and its dependencies.
sudo yum install -y gcc libxml2-devel libxslt-devel libffi-devel libpq-devel openssl-devel redhat-rpm-config
```
Before continuing, check that your installed Python version is at least 3.8:
Before continuing, check that your installed Python version is at least 3.10:
```no-highlight
python3 -V
@ -255,10 +255,10 @@ Once NetBox has been configured, we're ready to proceed with the actual installa
sudo /opt/netbox/upgrade.sh
```
Note that **Python 3.8 or later is required** for NetBox v3.2 and later releases. If the default Python installation on your server is set to a lesser version, pass the path to the supported installation as an environment variable named `PYTHON`. (Note that the environment variable must be passed _after_ the `sudo` command.)
Note that **Python 3.10 or later is required** for NetBox v4.0 and later releases. If the default Python installation on your server is set to a lesser version, pass the path to the supported installation as an environment variable named `PYTHON`. (Note that the environment variable must be passed _after_ the `sudo` command.)
```no-highlight
sudo PYTHON=/usr/bin/python3.8 /opt/netbox/upgrade.sh
sudo PYTHON=/usr/bin/python3.10 /opt/netbox/upgrade.sh
```
!!! note

2
docs/installation/index.md
View File

@ -20,7 +20,7 @@ The following sections detail how to set up a new instance of NetBox:
| Dependency | Minimum Version |
|------------|-----------------|
| Python | 3.8 |
| Python | 3.10 |
| PostgreSQL | 12 |
| Redis | 4.0 |

6
docs/installation/upgrading.md
View File

@ -19,7 +19,7 @@ NetBox requires the following dependencies:
| Dependency | Minimum Version |
|------------|-----------------|
| Python | 3.8 |
| Python | 3.10 |
| PostgreSQL | 12 |
| Redis | 4.0 |
@ -108,10 +108,10 @@ sudo ./upgrade.sh
```
!!! warning
If the default version of Python is not at least 3.8, you'll need to pass the path to a supported Python version as an environment variable when calling the upgrade script. For example:
If the default version of Python is not at least 3.10, you'll need to pass the path to a supported Python version as an environment variable when calling the upgrade script. For example:
```no-highlight
sudo PYTHON=/usr/bin/python3.8 ./upgrade.sh
sudo PYTHON=/usr/bin/python3.10 ./upgrade.sh
```
This script performs the following actions:

4
docs/plugins/development/index.md
View File

@ -135,7 +135,7 @@ Any additional apps must be installed within the same Python environment as NetB
## Create setup.py
`setup.py` is the [setup script](https://docs.python.org/3.8/distutils/setupscript.html) used to package and install our plugin once it's finished. The primary function of this script is to call the setuptools library's `setup()` function to create a Python distribution package. We can pass a number of keyword arguments to control the package creation as well as to provide metadata about the plugin. An example `setup.py` is below:
`setup.py` is the [setup script](https://docs.python.org/3.10/distutils/setupscript.html) used to package and install our plugin once it's finished. The primary function of this script is to call the setuptools library's `setup()` function to create a Python distribution package. We can pass a number of keyword arguments to control the package creation as well as to provide metadata about the plugin. An example `setup.py` is below:
```python
from setuptools import find_packages, setup
@ -170,7 +170,7 @@ python3 -m venv ~/.virtualenvs/my_plugin
You can make NetBox available within this environment by creating a path file pointing to its location. This will add NetBox to the Python path upon activation. (Be sure to adjust the command below to specify your actual virtual environment path, Python version, and NetBox installation.)
```shell
echo /opt/netbox/netbox > $VENV/lib/python3.8/site-packages/netbox.pth
echo /opt/netbox/netbox > $VENV/lib/python3.10/site-packages/netbox.pth
```
## Development Installation

1
docs/release-notes/version-3.7.md
View File

@ -10,6 +10,7 @@
* The internal ConfigRevision model has moved from `extras` to `core`. Configuration history will be retained throughout the upgrade process.
* The [L2VPN](../models/vpn/l2vpn.md) and [L2VPNTermination](../models/vpn/l2vpntermination.md) models have moved from the `ipam` app to the new `vpn` app. All object data will be retained, however please note that the relevant API endpoints have likewise moved to `/api/vpn/`.
* The `CustomFieldsMixin`, `SavedFiltersMixin`, and `TagsMixin` classes have moved from the `extras.forms.mixins` module to `netbox.forms.mixins`.
* The `netbox.models.features.WebhooksMixin` class has been renamed to `EventRulesMixin`.
### New Features

6
netbox/dcim/tests/test_views.py
View File

@ -1,9 +1,5 @@
from decimal import Decimal
try:
from zoneinfo import ZoneInfo
except ImportError:
# Python 3.8
from backports.zoneinfo import ZoneInfo
from zoneinfo import ZoneInfo
import yaml
from django.contrib.auth import get_user_model

9
netbox/extras/plugins/__init__.py
View File

@ -1,9 +0,0 @@
from .navigation import *
from .registration import *
from .templates import *
from .utils import *
from netbox.plugins import PluginConfig
# TODO: Remove in v4.0
warnings.warn(f"{__name__} is deprecated. Import from netbox.plugins instead.", DeprecationWarning)

7
netbox/extras/plugins/navigation.py
View File

@ -1,7 +0,0 @@
import warnings
from netbox.plugins.navigation import *
# TODO: Remove in v4.0
warnings.warn(f"{__name__} is deprecated. Import from netbox.plugins instead.", DeprecationWarning)

7
netbox/extras/plugins/registration.py
View File

@ -1,7 +0,0 @@
import warnings
from netbox.plugins.registration import *
# TODO: Remove in v4.0
warnings.warn(f"{__name__} is deprecated. Import from netbox.plugins instead.", DeprecationWarning)

7
netbox/extras/plugins/templates.py
View File

@ -1,7 +0,0 @@
import warnings
from netbox.plugins.templates import *
# TODO: Remove in v4.0
warnings.warn(f"{__name__} is deprecated. Import from netbox.plugins instead.", DeprecationWarning)

7
netbox/extras/plugins/urls.py
View File

@ -1,7 +0,0 @@
import warnings
from netbox.plugins.urls import *
# TODO: Remove in v4.0
warnings.warn(f"{__name__} is deprecated. Import from netbox.plugins instead.", DeprecationWarning)

7
netbox/extras/plugins/utils.py
View File

@ -1,7 +0,0 @@
import warnings
from netbox.plugins.utils import *
# TODO: Remove in v4.0
warnings.warn(f"{__name__} is deprecated. Import from netbox.plugins instead.", DeprecationWarning)

7
netbox/extras/plugins/views.py
View File

@ -1,7 +0,0 @@
import warnings
from netbox.plugins.views import *
# TODO: Remove in v4.0
warnings.warn(f"{__name__} is deprecated. Import from netbox.plugins instead.", DeprecationWarning)

10
netbox/extras/webhooks_worker.py
View File

@ -1,10 +0,0 @@
import warnings
from .webhooks import send_webhook as process_webhook
# TODO: Remove in v4.0
warnings.warn(
f"webhooks_worker.process_webhook has been moved to webhooks.send_webhook.",
DeprecationWarning
)

2
netbox/netbox/models/features.py
View File

@ -30,13 +30,13 @@ __all__ = (
'CustomFieldsMixin',
'CustomLinksMixin',
'CustomValidationMixin',
'EventRulesMixin',
'ExportTemplatesMixin',
'ImageAttachmentsMixin',
'JobsMixin',
'JournalingMixin',
'SyncedDataMixin',
'TagsMixin',
'EventRulesMixin',
)

7
netbox/netbox/settings.py
View File

@ -3,17 +3,18 @@ import importlib
import importlib.util
import os
import platform
import requests
import sys
import warnings
from urllib.parse import urlencode, urlsplit
import django
import requests
from django.contrib.messages import constants as messages
from django.core.exceptions import ImproperlyConfigured, ValidationError
from django.core.validators import URLValidator
from django.utils.encoding import force_str
from django.utils.translation import gettext_lazy as _
try:
import sentry_sdk
except ModuleNotFoundError:
@ -37,9 +38,9 @@ HOSTNAME = platform.node()
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
# Validate Python version
if sys.version_info < (3, 8):
if sys.version_info < (3, 10):
raise RuntimeError(
f"NetBox requires Python 3.8 or later. (Currently installed: Python {platform.python_version()})"
f"NetBox requires Python 3.10 or later. (Currently installed: Python {platform.python_version()})"
)
#

31
netbox/netbox/views/generic/mixins.py
View File

@ -1,5 +1,3 @@
import warnings
from netbox.constants import DEFAULT_ACTION_PERMISSIONS
from utilities.permissions import get_permission_for_model
@ -26,38 +24,11 @@ class ActionsMixin:
"""
model = model or self.queryset.model
# TODO: Remove backward compatibility in Netbox v4.0
# Determine how permissions are being mapped to actions for the view
if hasattr(self, 'action_perms'):
# Backward compatibility for <3.7
permissions_map = self.action_perms
warnings.warn(
"Setting action_perms on views is deprecated and will be removed in NetBox v4.0. Use actions instead.",
DeprecationWarning
)
elif type(self.actions) is dict:
# New actions format (3.7+)
permissions_map = self.actions
else:
# actions is still defined as a list or tuple (<3.7) but no custom mapping is defined; use the old
# default mapping
permissions_map = {
'add': {'add'},
'import': {'add'},
'bulk_edit': {'change'},
'bulk_delete': {'delete'},
}
warnings.warn(
"View actions should be defined as a dictionary mapping. Support for the legacy list format will be "
"removed in NetBox v4.0.",
DeprecationWarning
)
# Resolve required permissions for each action
permitted_actions = []
for action in self.actions:
required_permissions = [
get_permission_for_model(model, name) for name in permissions_map.get(action, set())
get_permission_for_model(model, name) for name in self.actions.get(action, set())
]
if not required_permissions or user.has_perms(required_permissions):
permitted_actions.append(action)