zonar-ds-env-arg-parser 1.0.1

zonar_ds_env_arg_parser
======

概述
------
这是一个简单的帮助程序，旨在强制和验证环境变量是否设置正确

用法
------
```python3
from zonar_ds_env_arg_parser.env_arg_parser import env_arg_parser as parser

parser.add_argument(env_var="SOME_EVN_VAR",
required=True,
type=int,
help="关于变量显示的消息")

parser.add_argument(env_var="SOMETHING_ELSE",
required=False,
default="TEST",
验证=lambda x: x.lower() == "测试" 或
x.lower() == "something" or
x.lower() == "something_else",
help="Some message about this variable")

parser.add_argument(env_var="TRUE",
required=False,
default="True ",
type=bool, # 将("yes", "true", "t", "1", "y", "yeah") 转换为True
help="关于转换为True的另一种描述")

parser.initialize ()
options = parser.get_options()

# 这个 var 没有默认值，所以需要设置 'SOME_EVN_VAR'会抛出异常
print("This is the type of SOME_EVN_VAR " + type(options.SOME_EVN_VAR)) # 应该是 int 因为我们指定了 type
print("This is the value of SOMETHING_ELSE " + options.ENVIRONMENT) # 应该是 'TEST' 因为那是default
print("This is the value of TRUE " + options.TRUE) # 应该是'TEST'，因为这是默认的
```

Arguments
------
可以传入env_arg_parser.add_argument的参数如下：

| 参数 | 必填 | 说明 |
|-------|---------|-------------|
| 环境变量 | 是 | 要查找的环境变量。这也是检索属性时的名称。|
| 必填 | 是 | 可以是真或假，如果 required=False 必须提供默认值。|
| 帮助 | 是 | 如果参数不存在或验证失败，则会显示此消息。它应该向用户解释参数的用途，以帮助他们定义它。|
| 默认 | 有条件的 | 默认值。如果 required=False 则必须设置，如果 required=True 则不能设置。|
| 验证 | 没有 | 应提供一个函数，该函数采用单个值并应返回 True、False 或引发异常。False 或异常将阻止程序启动。|
| 类型 | 没有 | 如果该值需要不是字符串，请指定应转换为的值。