pip3 install secsie-confSecsie 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.
- easier to read
- faster and more natural to write
- no special syntax required for strings vs ints, floats, bools, etc.
- file size usually smaller than readable JSON
These are the rules of the secsie config language:
- Comment lines begin with
#or;, but inline comments can only begin with the octothorpe (#) and must have a space preceding them. - 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 begin 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(case insensitive),0-9,_, and-are allowed in section tag names, while other special characters are allowed in key names. - Values can consist of any character except
#. Leading and trailing whitespace is removed. String values separated by commas are interpreted as lists.
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.
- 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;) - Lists in
.inifiles can have a trailing comma with no effect, but a trailing comma insecsiewill create a blank string
secsie-confcan NOT be used to write.inifiles. You can read an.inifile and output it in validsecsie, but you cannot expect valid.inioutput.
Secsie supports strings, ints, floats, null types, booleans, and lists. Most of these types can be written out by themselves and will automatically be converted to the appropriate native type. Lists require comma separation.
# Spaces are allowed in string value
string_key = whatever value you wantnumb = 42 # Automatically converted to int when parsedpi = 3.14159265 # Automatically converted to float when parsed# 'null' is used as the NoneType (case insensitive)
nothing = null# 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# To interpret a value as a list, you must separate the list values with a comma.
list = this, that, the otherexamples/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
# this following will be interpreted as a list
coolKids = jim, bill, bob, alice, 42
# 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, 'coolKids': ['jim', 'bill', 'bob', 'alice', 42], 'nah': None}, 'anotherSection': {'sections': 'are amazing'}}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 prettynessResult:
{
"before_section": "totally okay",
"special_values": {
"int": 42,
"float": 269.887,
"truth": true,
"falsehood": false,
"true": true,
"false": false,
"coolKids": [
"jim",
"bill",
"bob",
"alice",
42
],
"nah": null
},
"anotherSection": {
"sections": "are amazing"
}
}import json
import secsie
# This might not work...
config = secsie.parse_config_file('examples/php.ini')Result:
Traceback (most recent call last):
...
File "/Users/nbroyles/PycharmProjects/secsie-conf/secsie/__init__.py", line 90, in _write_to_conf_
raise InvalidSyntax(f'"{line}" - bad section descriptor or value assignment', line_number)
File "<string>", line 955
secsie.InvalidSyntax: Invalid syntax on line 955: "[CLI Server]" - bad section descriptor or value assignmentWe can see that this up and broke. WTF?! Actually, it's 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": "nocache",
"session.cache_expire": 180,
"session.use_trans_sid": 0,
"session.sid_length": 26,
"session.trans_sid_tags": [
"a=href",
"area=href",
"frame=src",
"form="
],
"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!
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 = nocache
session.cache_expire = 180
session.use_trans_sid = 0
session.sid_length = 26
session.trans_sid_tags = a=href, area=href, frame=src, form=
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
You should notice 2 things:
- Keys and value assignments are separated by an equals sign with a space ON BOTH SIDES!
key = value, NOTkey=value. That is ugly and lazy. This ain't minified JS, son. They make things for that... - Blank values were commented out. If you disagree with that, MAKE 'EM NULL!
key =doesn't say anything.