Table of Contents
1. Write the configuration in a Python file
2. Use external configuration files
linux, ubuntu environment variables
windows environment variables
3. Directly use the system environment variables to read the configuration
4. Microservice architecture
5. Recommended configuration methods in general projects
Home Backend Development Python Tutorial What is the correct way to read and write configuration in a Python project?

What is the correct way to read and write configuration in a Python project?

May 09, 2023 pm 07:16 PM
python Configuration file

What is the correct way to read and write configuration in a Python project?

1. Write the configuration in a Python file

This method is very simple, but it has serious security issues. We all know that we should not The configuration is written in the code. If someone uploads our source code to github, then the database configuration is equivalent to being disclosed to the world. Of course, this simple configuration can also be used when the configuration file does not contain sensitive information. method.

2. Use external configuration files

to make the configuration files and code independent. The file format of json, yaml or ini is usually used to store the configuration.

Combines environment variables and python libraries to read external files. First of all, development usually does not come into contact with the generation environment, so the configuration file of the generation environment is written by operation and maintenance, and operation and maintenance will apply all After the required configuration is written, place it in the specified location on the production server, and the code reads the configuration from the specified location.

In order to facilitate unified debugging of the program, a system environment variable (XXX_CONFIG_PATH) can be agreed in advance to specify the storage path of the configuration file.

For example: export XXX_CONFIG_PATH =
/home/test/configs/config.ini
This is to set temporary environment variables

linux, ubuntu environment variables

查看环境变量:
 env
 设置永久环境变量
 1.在/etc/profile 的文件下编辑,所改变的环境变量是面向所有用户的
 export CLASSPATH = /../...该路径为绝对路径
 2.在当前用户目录下./barsh_profile文件中修改 进行修改的话,仅对当前的用户生效
 vim /home/wens/.barshc
 export CLASSPATH = /../...该路径为绝对路径
 最后使用source命令 可以直接使环境变量生效
 source/home/wens/.barshc //直接跟环境变量的文件
Copy after login

windows environment variables

查看环境变量:
 set
 查看某个环境变量:
 set path
 修改环境变量
 输入 “set 变量名=变量内容”即可。比如将path设置为“d:nmake.exe”,只要输入set path="d:nmake.exe"
 注意:所有的在cmd命令行下对环境变量的修改只对当前窗口有效,不是永久性的修改。也就是说当关闭此cmd命令行窗口后,将不再起作用。
 永久性修改环境变量的方法有两种:
 一种是直接修改注册表
 另一种是通过我的电脑-〉属性-〉高级,来设置系统的环境变量(查看详细) 
 设置了环境变量后,需要重启 pycharm 生效
Copy after login

3. Directly use the system environment variables to read the configuration

This method It is common in practice not to use files to store configuration information, but to store all configuration information in environment variables. Operations and maintenance use ansible deployment scripts to import the information that needs to be configured into environment variables before running the program.

Not using file storage strengthens the protection of configuration information such as passwords to a certain extent, but it also increases the workload of operation and maintenance, especially when the configuration needs to be modified.

4. Microservice architecture

In some microservice architectures, a configuration center will be specially developed. The program will directly read the configuration from online, and the management of the configuration will also be done. Develop a GUI to facilitate development and operation and maintenance.

-app
-__init.py
-app.py
-settings
 -__init__.py
 -base.py
 -dev.py
 -prod.py
Copy after login

Among them, add judgment logic to determine the current environment to use the development environment Or a production environment, thus loading different configuration parameters.

# settings/__init__.py
 import os
 # os.environ.get() 用于获取系统中的环境变量,因为在生产环境中,一般都会把一些关键性的参数写到系统的环境中。
 # 所以PROFILE的值其实就是我们配置的环境变量的值。如果没有配这个值,默认走dev的配置。
 # PYTHON_PRO_PROFILE = os.environ.get("PYTHON_PRO_PROFILE", "dev")
 PYTHON_PRO_PROFILE = os.environ.get("PYTHON_PRO_PROFILE")
 print("是开发环境还是生产环境: ", PYTHON_PRO_PROFILE) 
 if PYTHON_PRO_PROFILE == "dev":
 from .dev import *
 elif PYTHON_PRO_PROFILE == "prod":
 from .prod import *
 else:
 raise Exception("Not supported runtime profile {}".format(PYTHON_PRO_PROFILE))
Copy after login

base.py stores some common configurations, and then in the development environment dev.py and the production environment prod. Import the variables of base.py in py.

# settings/base.py
 import os
 import time
 # os.path.abspath: 获取完整路径(包含文件名)
 current_exec_abspath = os.path.abspath(__file__)
 current_exec_dir_name, _ = os.path.split(current_exec_abspath)
 current_up_dir, _ = os.path.split(current_exec_dir_name)
 current_up2_dir, _ = os.path.split(current_up_dir)
 print('------log dir=------', current_up2_dir)
 # 日志文件路径设置
 log_path = f"{current_up2_dir}/logs"
 if not os.path.exists(log_path):
 os.makedirs(log_path)
 t = time.strftime("%Y_%m_%d")
 log_path_file = f"{log_path}/interface_log_{t}.log"
Copy after login

where

dev.py:

# 导入了base下所有参数
 from .base import *
 database = {
 "protocol": "mysql+mysqlconnector",
 "username": "xxxxxx",
 "password": "hash string",
 "port": 3306,
 "database": "repo"
 }
Copy after login

where

prod.py:

# 导入了base下所有参数
 from .base import *
 database = {
 "protocol": "xxxxxxxxxxx",
 "username": "xxxxxxxxxxx",
 "password": "xxxxxxxxxxx",
 "port": 3344,
 "database": "xxxx"
 }
 对于一些敏感信息可在环境变量里设置,通过如下方法获取,例如:
 MAIL_SERVER = os.environ.get('MAIL_SERVER', 'smtp.163.com') 
 MAIL_USERNAME = os.environ.get('MAIL_USERNAME') or 'test'
 MAIL_PASSWORD = os.environ.get('MAIL_PASSWORD') or '12345678'
Copy after login

The above is the detailed content of What is the correct way to read and write configuration in a Python project?. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Best Graphic Settings
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. How to Fix Audio if You Can't Hear Anyone
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Chat Commands and How to Use Them
4 weeks ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

How to use Debian Apache logs to improve website performance How to use Debian Apache logs to improve website performance Apr 12, 2025 pm 11:36 PM

This article will explain how to improve website performance by analyzing Apache logs under the Debian system. 1. Log Analysis Basics Apache log records the detailed information of all HTTP requests, including IP address, timestamp, request URL, HTTP method and response code. In Debian systems, these logs are usually located in the /var/log/apache2/access.log and /var/log/apache2/error.log directories. Understanding the log structure is the first step in effective analysis. 2. Log analysis tool You can use a variety of tools to analyze Apache logs: Command line tools: grep, awk, sed and other command line tools.

Python: Games, GUIs, and More Python: Games, GUIs, and More Apr 13, 2025 am 12:14 AM

Python excels in gaming and GUI development. 1) Game development uses Pygame, providing drawing, audio and other functions, which are suitable for creating 2D games. 2) GUI development can choose Tkinter or PyQt. Tkinter is simple and easy to use, PyQt has rich functions and is suitable for professional development.

PHP and Python: Comparing Two Popular Programming Languages PHP and Python: Comparing Two Popular Programming Languages Apr 14, 2025 am 12:13 AM

PHP and Python each have their own advantages, and choose according to project requirements. 1.PHP is suitable for web development, especially for rapid development and maintenance of websites. 2. Python is suitable for data science, machine learning and artificial intelligence, with concise syntax and suitable for beginners.

How debian readdir integrates with other tools How debian readdir integrates with other tools Apr 13, 2025 am 09:42 AM

The readdir function in the Debian system is a system call used to read directory contents and is often used in C programming. This article will explain how to integrate readdir with other tools to enhance its functionality. Method 1: Combining C language program and pipeline First, write a C program to call the readdir function and output the result: #include#include#include#includeintmain(intargc,char*argv[]){DIR*dir;structdirent*entry;if(argc!=2){

The role of Debian Sniffer in DDoS attack detection The role of Debian Sniffer in DDoS attack detection Apr 12, 2025 pm 10:42 PM

This article discusses the DDoS attack detection method. Although no direct application case of "DebianSniffer" was found, the following methods can be used for DDoS attack detection: Effective DDoS attack detection technology: Detection based on traffic analysis: identifying DDoS attacks by monitoring abnormal patterns of network traffic, such as sudden traffic growth, surge in connections on specific ports, etc. This can be achieved using a variety of tools, including but not limited to professional network monitoring systems and custom scripts. For example, Python scripts combined with pyshark and colorama libraries can monitor network traffic in real time and issue alerts. Detection based on statistical analysis: By analyzing statistical characteristics of network traffic, such as data

Python and Time: Making the Most of Your Study Time Python and Time: Making the Most of Your Study Time Apr 14, 2025 am 12:02 AM

To maximize the efficiency of learning Python in a limited time, you can use Python's datetime, time, and schedule modules. 1. The datetime module is used to record and plan learning time. 2. The time module helps to set study and rest time. 3. The schedule module automatically arranges weekly learning tasks.

Nginx SSL Certificate Update Debian Tutorial Nginx SSL Certificate Update Debian Tutorial Apr 13, 2025 am 07:21 AM

This article will guide you on how to update your NginxSSL certificate on your Debian system. Step 1: Install Certbot First, make sure your system has certbot and python3-certbot-nginx packages installed. If not installed, please execute the following command: sudoapt-getupdatesudoapt-getinstallcertbotpython3-certbot-nginx Step 2: Obtain and configure the certificate Use the certbot command to obtain the Let'sEncrypt certificate and configure Nginx: sudocertbot--nginx Follow the prompts to select

How to configure HTTPS server in Debian OpenSSL How to configure HTTPS server in Debian OpenSSL Apr 13, 2025 am 11:03 AM

Configuring an HTTPS server on a Debian system involves several steps, including installing the necessary software, generating an SSL certificate, and configuring a web server (such as Apache or Nginx) to use an SSL certificate. Here is a basic guide, assuming you are using an ApacheWeb server. 1. Install the necessary software First, make sure your system is up to date and install Apache and OpenSSL: sudoaptupdatesudoaptupgradesudoaptinsta

See all articles