本文由 大侠(AhcaoZhu)原创，转载请声明。
链接: https://blog.csdn.net/Ahcao2008
一图看懂 dotenv 模块：从.env文件中读取键值对，并将其设置为环境变量，资料整理+笔记（大全）
- 摘要
- 模块图
- 类关系图
- 模块全展开
- 【dotenv】
- 统计
- 常量
- 模块
- 1 dotenv.parser
- 2 dotenv.variables
- 3 dotenv.main
- 函数
- 4 dotenv_values(dotenv_path: Union[str, ForwardRef('os.PathLike[str]'), NoneType] = None, stream: Union[IO[str], NoneType] = None, verbose: bool = False, interpolate: bool = True, encoding: Union[str, NoneType] = 'utf-8') -> Dict[str, Union[str, NoneType]]
- 5 find_dotenv(filename: str = '.env', raise_error_if_not_found: bool = False, usecwd: bool = False) -> str
- 6 get_key(dotenv_path: Union[str, ForwardRef('os.PathLike[str]')], key_to_get: str, encoding: Union[str, NoneType] = 'utf-8') -> Union[str, NoneType]
- 7 load_dotenv(dotenv_path: Union[str, ForwardRef('os.PathLike[str]'), NoneType] = None, stream: Union[IO[str], NoneType] = None, verbose: bool = False, override: bool = False, interpolate: bool = True, encoding: Union[str, NoneType] = 'utf-8') -> bool
- 8 set_key(dotenv_path: Union[str, ForwardRef('os.PathLike[str]')], key_to_set: str, value_to_set: str, quote_mode: str = 'always', export: bool = False, encoding: Union[str, NoneType] = 'utf-8') -> Tuple[Union[bool, NoneType], str, str]
- 9 unset_key(dotenv_path: Union[str, ForwardRef('os.PathLike[str]')], key_to_unset: str, quote_mode: str = 'always', encoding: Union[str, NoneType] = 'utf-8') -> Tuple[Union[bool, NoneType], str]
- 10 load_ipython_extension(ipython: Any) -> None
- 11 get_cli_string(path: Union[str, NoneType] = None, action: Union[str, NoneType] = None, key: Union[str, NoneType] = None, value: Union[str, NoneType] = None, quote: Union[str, NoneType] = None)
- 剩余
- 【dotenv.parser】
- 【dotenv.variables】
- 【dotenv.main】
- 【codecs】
- 【re】
- 【io】
- 【logging】
- 【os】
- 【shutil】
- 【sys】
- 【tempfile】
摘要
全文介绍系统内置 dotenv 模块、函数、类及类的方法和属性。
它通过代码抓取并经AI智能翻译和人工校对。
是一部不可多得的权威字典类工具书。它是系列集的一部分。后续陆续发布、敬请关注。【原创：AhcaoZhu大侠】
模块图
dotenv
dotenv.parser
dotenv.variables
dotenv.main
类关系图
◆object
◆BaseException
◆Exception
dotenv.parser.Error
dotenv.main.DotEnv
dotenv.parser.Position
dotenv.parser.Reader
dotenv.variables.Atom
dotenv.variables.Literal
dotenv.variables.Variable
◆tuple
dotenv.parser.Binding
dotenv.parser.Original
模块全展开
【dotenv】
dotenv, fullname=dotenv, file=dotenv_init_.py
统计
| 序号 | 类别 | 数量 |
|---|---|---|
| 4 | str | 4 |
| 6 | list | 2 |
| 8 | dict | 1 |
| 9 | module | 3 |
| 11 | function | 8 |
| 13 | residual | 5 |
| 14 | system | 10 |
| 16 | all | 23 |
常量
模块
1 dotenv.parser
parser, fullname=dotenv.parser, file=dotenv\parser.py
2 dotenv.variables
variables, fullname=dotenv.variables, file=dotenv\variables.py
3 dotenv.main
main, fullname=dotenv.main, file=dotenv\main.py
函数
4 dotenv_values(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’), NoneType] = None, stream: Union[IO[str], NoneType] = None, verbose: bool = False, interpolate: bool = True, encoding: Union[str, NoneType] = ‘utf-8’) -> Dict[str, Union[str, NoneType]]
dotenv_values(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’), NoneType] = None, stream: Union[IO[str], NoneType] = None, verbose: bool = False, interpolate: bool = True, encoding: Union[str, NoneType] = ‘utf-8’) -> Dict[str, Union[str, NoneType]], module=dotenv.main, line:349 at site-packages\dotenv\main.py
解析.env文件并将其内容作为字典返回。
对于.env文件中没有值的键，返回的字典将具有'None'值。
例如，'foo=bar'导致 `{"foo": "bar"}` ，而 `foo` 单独导致 `{"foo": None}`。
参数:
dotenv_path: .env文件的绝对或相对路径。
stream:带有.env内容的`StringIO`对象，当 `dotenv_path` 为 `None` 时使用。
verbose:如果.env文件丢失，是否输出警告。
encoding:用于读取文件的编码。
如果 `dotenv_path` 和 `stream` 都为 `None` ，则使用 `find_dotenv()` 来查找.env文件。
5 find_dotenv(filename: str = ‘.env’, raise_error_if_not_found: bool = False, usecwd: bool = False) -> str
find_dotenv(filename: str = ‘.env’, raise_error_if_not_found: bool = False, usecwd: bool = False) -> str, module=dotenv.main, line:270 at site-packages\dotenv\main.py
在越来越高的文件夹中搜索给定文件，如果找到则返回文件的路径，否则返回空字符串
6 get_key(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’)], key_to_get: str, encoding: Union[str, NoneType] = ‘utf-8’) -> Union[str, NoneType]
get_key(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’)], key_to_get: str, encoding: Union[str, NoneType] = ‘utf-8’) -> Union[str, NoneType], module=dotenv.main, line:116 at site-packages\dotenv\main.py
从给定的.env中获取给定键的值。如果没有找到键或没有值，则返回`None`。
7 load_dotenv(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’), NoneType] = None, stream: Union[IO[str], NoneType] = None, verbose: bool = False, override: bool = False, interpolate: bool = True, encoding: Union[str, NoneType] = ‘utf-8’) -> bool
load_dotenv(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’), NoneType] = None, stream: Union[IO[str], NoneType] = None, verbose: bool = False, override: bool = False, interpolate: bool = True, encoding: Union[str, NoneType] = ‘utf-8’) -> bool, module=dotenv.main, line:311 at site-packages\dotenv\main.py
解析.env文件，然后将找到的所有变量加载为环境变量。
参数说明:
dotenv_path: .env文件的绝对路径或相对路径。
stream: 带有.env内容的文本流(如`io.StringIO`)，当 `dotenv_path` 为 `None` 时使用。
verbose: 是否输出.env文件丢失的警告。
override:是否使用`.env`的文件中的变量覆盖系统环境变量。
encoding: 用于读取文件的编码。
返回:
Bool: 当至少有一个环境变量被设置时，为True，否则为 False。
如果 `dotenv_path` 和 `stream` 都为 `None` ，则使用 `find_dotenv()` 来查找.env文件。
8 set_key(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’)], key_to_set: str, value_to_set: str, quote_mode: str = ‘always’, export: bool = False, encoding: Union[str, NoneType] = ‘utf-8’) -> Tuple[Union[bool, NoneType], str, str]
set_key(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’)], key_to_set: str, value_to_set: str, quote_mode: str = ‘always’, export: bool = False, encoding: Union[str, NoneType] = ‘utf-8’) -> Tuple[Union[bool, NoneType], str, str], module=dotenv.main, line:147 at site-packages\dotenv\main.py
对给定的.env增加或更新一个 key/value 对。
如果给定的.env路径不存在，则失败，而不是冒险在文件系统的某个地方创建一个孤立的.env
9 unset_key(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’)], key_to_unset: str, quote_mode: str = ‘always’, encoding: Union[str, NoneType] = ‘utf-8’) -> Tuple[Union[bool, NoneType], str]
unset_key(dotenv_path: Union[str, ForwardRef(‘os.PathLike[str]’)], key_to_unset: str, quote_mode: str = ‘always’, encoding: Union[str, NoneType] = ‘utf-8’) -> Tuple[Union[bool, NoneType], str], module=dotenv.main, line:196 at site-packages\dotenv\main.py
从给定的`.env`文件中删除给定的键。
如果给定的.env路径不存在，则失败。如果给定的键在.env中不存在，则失败。
10 load_ipython_extension(ipython: Any) -> None
load_ipython_extension(ipython: Any) -> None, module=dotenv, line:7 at site-packages\dotenv_init_.py
11 get_cli_string(path: Union[str, NoneType] = None, action: Union[str, NoneType] = None, key: Union[str, NoneType] = None, value: Union[str, NoneType] = None, quote: Union[str, NoneType] = None)
get_cli_string(path: Union[str, NoneType] = None, action: Union[str, NoneType] = None, key: Union[str, NoneType] = None, value: Union[str, NoneType] = None, quote: Union[str, NoneType] = None), module=dotenv, line:12 at site-packages\dotenv_init_.py
返回适合作为shell脚本运行的字符串。
用于将传递给结构任务的参数转换为传递给'local'或'run'命令。
剩余
12 doc
13 loader <_frozen_importlib_external.SourceFileLoader object at 0x000001A76FDA0288>
14 spec ModuleSpec(name=‘dotenv’, loader=<_frozen_importlib_external.SourceFileLoader object at 0x000001A76FDA0288>, origin=‘…\lib\site-packages\dotenv\init.py’, submodule_search_locations=[‘…\lib\site-packages\dotenv’])
15 Any typing.Any
16 Optional typing.Optional
【dotenv.parser】
parser, fullname=dotenv.parser, file=dotenv\parser.py
【dotenv.variables】
variables, fullname=dotenv.variables, file=dotenv\variables.py
【dotenv.main】
main, fullname=dotenv.main, file=dotenv\main.py
【codecs】
codecs, fullname=codecs, file=codecs.py
【re】
re, fullname=re, file=re.py
【io】
io, fullname=io, file=io.py
【logging】
logging, fullname=logging, file=logging_init_.py
【os】
os, fullname=os, file=os.py
【shutil】
shutil, fullname=shutil, file=shutil.py
【sys】
sys, fullname=sys
【tempfile】
tempfile, fullname=tempfile, file=tempfile.py
