secsie-conf
pip3 install secsie-conf
Secsie is a configuration language parser for Python, made for speed and beauty. Instead of writing config files in JSON (don't get me wrong, JSON is FAR better than a lot of other things you could use (cough cough XML)), you can save time writing your config files in secsie.
The secsie language format is very similar to ini, except just a little better. You can use secsie-conf to read .ini files into Python dicts. secsie-conf will NOT write .ini files however, at least at this stage.
Advantages over JSON:
- easier to read
- faster to write
- no special syntax required for strings vs ints, floats, bools, etc.
Secsie Language Contructs
These are the rules of the secsie config language:
- Comment lines begin with
#or;, but inline comments can only begin with the octothorpe (#). - Whitespace is ignored everywhere except in key names and section tag names.
- A config file consists of sections and attributes(keys and values).
- A section ends where the next section begins. Attributes declared before sections are valid.
- To begin a section use the following syntax:
[section1]
# attribute lines in this section follow
- The syntax for an attribute line is:
key = value
- Spaces are not allowed in key names or section tags. Only
a-z,A-Z,0-9and_are allowed in section tag names, while special characters are allowed in key names. - Values can consist of any character except
#. Leading and trailing whitespace is removed.
INI
secsie-conf can be used to read .ini files, as long as the mode ini is specifed to the parser. The rules of interpretation for .ini files vary slightly.
Differences:
- Section names are allowed to contain spaces and dashes
- quoted strings are valid, but the quotes are removed (there is no need to quote string in
secsie;)
secsie-confcan NOT be used to write.inifiles. You can read an.inifile and output it in validsecsie, but you cannot expect valid.inioutput.
Valid values
Secsie supports strings, ints, floats, null types, and booleans. All of these types can be written out by themselves and will automatically be converted to the appropriate native type.
Strings:
# Spaces are allowed in string value
string_key = whatever value you want
Ints:
numb = 42 # Automatically converted to int when parsed
Floats:
pi = 3.14159265 # Automatically converted to float when parsed
Booleans:
# True and yes are truthy values (case insensitive)
truth = true
truth2 = True
truth3 = yes
# False and no are falsy values (case insensitive)
untruth = falsE
untruth2 = False
untruth3 = no
Null type (None):
# 'null' is used as the NoneType (case insensitive)
nothing = null
Examples
examples/valid.secsie.conf:
; This is an example of a valid secsie file
before_section = totally okay
# Whitespace don't matter
; Here are examples of how types are interpreted(no keywords are off limits!)
[special_values]
int = 42
float = 269.887
truth = yes
falsehood = no
true = true
; I don't encourage this but it's valid ;)
false = FaLSe
# Null value
nah = Null
[anotherSection]
# The indent here is optional, included for readability
sections = are amazing
Parse result:
{'before_section': 'totally okay', 'special_values': {'int': 42, 'float': 269.887, 'truth': True, 'falsehood': False, 'true': True, 'false': False, 'nah': None}, 'anotherSection': {'sections': 'are amazing'}}
Module Usage
Read a secsie config file as a dict:
import json
import secsie
# To get a dict from a config file
config = secsie.parse_config_file('examples/valid.secsie.conf')
print(json.dumps(config, indent=2)) # For prettyness
Result:
{
"before_section": "totally okay",
"special_values": {
"int": 42,
"float": 269.887,
"truth": true,
"falsehood": false,
"true": true,
"false": false,
"nah": null
},
"anotherSection": {
"sections": "are amazing"
}
}
Read an .ini file:
import json
import secsie
# This might not work...
config = secsie.parse_config_file('examples/php.ini')
Result:
...Traceback (most recent call last): File "" , line 1, in <module> File "/home/nbroyles/PycharmProjects/secsie-conf/secsie/__init__.py", line 109, in parse_config_file conf = _write_to_conf_(conf, line, line_number=lineno, section=c_section, mode=mode) File "/home/nbroyles/PycharmProjects/secsie-conf/secsie/__init__.py", line 63, in _write_to_conf_ raise InvalidSyntax(f'Syntax Error on line {line_number}: "{line}" bad section descriptor or value assignment') secsie.InvalidSyntax: Syntax Error on line 955: "[CLI Server]" bad section descriptor or value assignment
We can see that this up and broke. Dub tee eff?! Actually, its okay. Spaces aren't allowed in secsie section names, remember? When reading an .ini file, we need to pass the argument mode='ini' to the parse_config_file function, like this:
config = secsie.parse_config_file('examples/php.ini', mode='ini')
print(json.dumps(config, indent=2))
{
"PHP": {
"engine": "On",
"short_open_tag": "Off",
"precision": 14,
"output_buffering": 4096,
"zlib.output_compression": "Off",
"implicit_flush": "Off",
"unserialize_callback_func": "",
"serialize_precision": -1,
"disable_functions": "pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare,",
"disable_classes": "",
"zend.enable_gc": "On",
"zend.exception_ignore_args": "On",
"expose_php": "Off",
"max_execution_time": 30,
"max_input_time": 60,
"memory_limit": "128M",
"error_reporting": "E_ALL & ~E_DEPRECATED & ~E_STRICT",
"display_errors": "Off",
"display_startup_errors": "Off",
"log_errors": "On",
"log_errors_max_len": 1024,
"ignore_repeated_errors": "Off",
"ignore_repeated_source": "Off",
"report_memleaks": "On",
"variables_order": "GPCS",
"request_order": "GP",
"register_argc_argv": "Off",
"auto_globals_jit": "On",
"post_max_size": "8M",
"auto_prepend_file": "",
"auto_append_file": "",
"default_mimetype": "text/html",
"default_charset": "UTF-8",
"doc_root": "",
"user_dir": "",
"enable_dl": "Off",
"file_uploads": "On",
"upload_max_filesize": "2M",
"max_file_uploads": 20,
"allow_url_fopen": "On",
"allow_url_include": "Off",
"default_socket_timeout": 60
},
"CLI Server": {
"cli_server.color": "On"
},
"Pdo_mysql": {
"pdo_mysql.default_socket": ""
},
"mail function": {
"SMTP": "localhost",
"smtp_port": 25,
"mail.add_x_header": "Off"
},
"ODBC": {
"odbc.allow_persistent": "On",
"odbc.check_persistent": "On",
"odbc.max_persistent": -1,
"odbc.max_links": -1,
"odbc.defaultlrl": 4096,
"odbc.defaultbinmode": 1
},
"MySQLi": {
"mysqli.max_persistent": -1,
"mysqli.allow_persistent": "On",
"mysqli.max_links": -1,
"mysqli.default_port": 3306,
"mysqli.default_socket": "",
"mysqli.default_host": "",
"mysqli.default_user": "",
"mysqli.default_pw": "",
"mysqli.reconnect": "Off"
},
"mysqlnd": {
"mysqlnd.collect_statistics": "On",
"mysqlnd.collect_memory_statistics": "Off"
},
"PostgreSQL": {
"pgsql.allow_persistent": "On",
"pgsql.auto_reset_persistent": "Off",
"pgsql.max_persistent": -1,
"pgsql.max_links": -1,
"pgsql.ignore_notice": 0,
"pgsql.log_notice": 0
},
"bcmath": {
"bcmath.scale": 0
},
"Session": {
"session.save_handler": "files",
"session.use_strict_mode": 0,
"session.use_cookies": 1,
"session.use_only_cookies": 1,
"session.name": "PHPSESSID",
"session.auto_start": 0,
"session.cookie_lifetime": 0,
"session.cookie_path": "/",
"session.cookie_domain": "",
"session.cookie_httponly": "",
"session.cookie_samesite": "",
"session.serialize_handler": "php",
"session.gc_probability": 0,
"session.gc_divisor": 1000,
"session.gc_maxlifetime": 1440,
"session.referer_check": "",
"session.cache_limiter": false,
"session.cache_expire": 180,
"session.use_trans_sid": 0,
"session.sid_length": 26,
"session.trans_sid_tags": "a",
"session.sid_bits_per_character": 5
},
"Assertion": {
"zend.assertions": -1
},
"Tidy": {
"tidy.clean_output": "Off"
},
"soap": {
"soap.wsdl_cache_enabled": 1,
"soap.wsdl_cache_dir": "/tmp",
"soap.wsdl_cache_ttl": 86400,
"soap.wsdl_cache_limit": 5
},
"ldap": {
"ldap.max_links": -1
}
}
That ^'s a whole PHP configuration file converted to some sexy secsie JSON!
Write a secsie file:
Now that we have the php.ini contents stored in config, let's output it in secsie!
secsie.generate_config_file(config, output_file='examples/php_ini.secsie.conf')
Output (examples/php_ini.secsie.conf):
# php_ini.secsie.conf auto-generated by secsie
[PHP]
engine = On
short_open_tag = Off
precision = 14
output_buffering = 4096
zlib.output_compression = Off
implicit_flush = Off
; unserialize_callback_func =
serialize_precision = -1
disable_functions = pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare,
; disable_classes =
zend.enable_gc = On
zend.exception_ignore_args = On
expose_php = Off
max_execution_time = 30
max_input_time = 60
memory_limit = 128M
error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT
display_errors = Off
display_startup_errors = Off
log_errors = On
log_errors_max_len = 1024
ignore_repeated_errors = Off
ignore_repeated_source = Off
report_memleaks = On
variables_order = GPCS
request_order = GP
register_argc_argv = Off
auto_globals_jit = On
post_max_size = 8M
; auto_prepend_file =
; auto_append_file =
default_mimetype = text/html
default_charset = UTF-8
; doc_root =
; user_dir =
enable_dl = Off
file_uploads = On
upload_max_filesize = 2M
max_file_uploads = 20
allow_url_fopen = On
allow_url_include = Off
default_socket_timeout = 60
[CLIServer]
cli_server.color = On
[Pdo_mysql]
; pdo_mysql.default_socket =
[mailfunction]
SMTP = localhost
smtp_port = 25
mail.add_x_header = Off
[ODBC]
odbc.allow_persistent = On
odbc.check_persistent = On
odbc.max_persistent = -1
odbc.max_links = -1
odbc.defaultlrl = 4096
odbc.defaultbinmode = 1
[MySQLi]
mysqli.max_persistent = -1
mysqli.allow_persistent = On
mysqli.max_links = -1
mysqli.default_port = 3306
; mysqli.default_socket =
; mysqli.default_host =
; mysqli.default_user =
; mysqli.default_pw =
mysqli.reconnect = Off
[mysqlnd]
mysqlnd.collect_statistics = On
mysqlnd.collect_memory_statistics = Off
[PostgreSQL]
pgsql.allow_persistent = On
pgsql.auto_reset_persistent = Off
pgsql.max_persistent = -1
pgsql.max_links = -1
pgsql.ignore_notice = 0
pgsql.log_notice = 0
[bcmath]
bcmath.scale = 0
[Session]
session.save_handler = files
session.use_strict_mode = 0
session.use_cookies = 1
session.use_only_cookies = 1
session.name = PHPSESSID
session.auto_start = 0
session.cookie_lifetime = 0
session.cookie_path = /
; session.cookie_domain =
; session.cookie_httponly =
; session.cookie_samesite =
session.serialize_handler = php
session.gc_probability = 0
session.gc_divisor = 1000
session.gc_maxlifetime = 1440
; session.referer_check =
session.cache_limiter = False
session.cache_expire = 180
session.use_trans_sid = 0
session.sid_length = 26
session.trans_sid_tags = a
session.sid_bits_per_character = 5
[Assertion]
zend.assertions = -1
[Tidy]
tidy.clean_output = Off
[soap]
soap.wsdl_cache_enabled = 1
soap.wsdl_cache_dir = /tmp
soap.wsdl_cache_ttl = 86400
soap.wsdl_cache_limit = 5
[ldap]
ldap.max_links = -1
Blank values were commented out. If you disagree with that, MAKE 'EM NULL!
5 Dec 23, 2022
1 Dec 17, 2021
11 Sep 15, 2022
24 Feb 16, 2022
942 Jan 5, 2023
75 Sep 9, 2022
63 Oct 30, 2022
18 Dec 2, 2022
1 Jan 17, 2022
7 Dec 27, 2022
3 Sep 18, 2022
2.8k Jan 6, 2023
1.4k Jan 2, 2023
18 Oct 27, 2022
2 Oct 9, 2021
6 Jun 29, 2022
0 Nov 21, 2022
8 Dec 14, 2022
62 Dec 23, 2022