TruxtonOptions - Revision history

Sam: /* Sample */

2024-01-27T19:13:47Z

Sample

Sam at 21:04, 16 September 2022

2022-09-16T21:04:04Z

Sam at 11:50, 29 July 2022

2022-07-29T11:50:24Z

Sam at 14:49, 5 March 2021

2021-03-05T14:49:46Z

Sam: /* Sample */

2021-02-09T14:55:01Z

Sample

Sam: /* Sample */

2021-02-06T15:24:56Z

Sample

Sam: Created page with "This class gives you access to configuration variables. =Methods= ==`getbool(name)`== This will retrieve a boolean setting from Truxton..."

2020-06-28T09:05:21Z

Created page with "This class gives you access to configuration variables. =Methods= ==<code>getbool(name)</code>== This will retrieve a boolean setting from Truxton..."

New page

This class gives you access to configuration variables.

=Methods=

==<code>getbool(name)</code>==
This will retrieve a boolean [[Configuration System | setting]] from Truxton based on its name.

==<code>getinteger(name)</code>==
This will retrieve an integer [[Configuration System | setting]] from Truxton based on its name.

==<code>getstring(name)</code>==
This will retrieve a string [[Configuration System | setting]] from Truxton based on its name.

=Sample=

<syntaxhighlight lang="Python" highlight="4,6-8">
import truxton

def main():
options = truxton.options()

print( "CreateTheDatabase: " + str(options.getbool("CreateTheDatabase")))
print( "dbport: " + str(options.getinteger("dbport")))
print( "dbname: " + str(options.getstring("dbname")))

if __name__ == "__main__":
main()
</syntaxhighlight>

@@ Line 33: / Line 33: @@
 if __name__ == "__main__":
-   main()
+   sys.exit(main())
 </source>

@@ Line 3: / Line 3: @@
 =Methods=
-==<code>exists(name: str) -> bool</code>==
+==<code>exists(name: str) -> boolean</code>==
 This will tell you if the named [[Configuration System|setting]] exists in the options.
 It will return [https://docs.python.org/3/library/constants.html#True True] if the option was specified somewhere, [https://docs.python.org/3/library/constants.html#False False] if the default value will be returned.
-==<code>getbool(name: str) -> bool</code>==
+==<code>getbool(name: str) -> boolean</code>==
 This will retrieve a boolean [[Configuration System|setting]] from Truxton based on its name.
 If the <code>name</code> setting could not be found, [https://docs.python.org/3/library/constants.html#False False] will be returned.

@@ Line 1: / Line 1: @@
-This class gives you access to configuration variables.
+This class gives you access to configuration variables in Truxton.
 =Methods=
-==<code>exists(name)</code>==
+==<code>exists(name: str) -> bool</code>==
 This will tell you if the named [[Configuration System|setting]] exists in the options.
 It will return [https://docs.python.org/3/library/constants.html#True True] if the option was specified somewhere, [https://docs.python.org/3/library/constants.html#False False] if the default value will be returned.
-==<code>getbool(name)</code>==
+==<code>getbool(name: str) -> bool</code>==
 This will retrieve a boolean [[Configuration System|setting]] from Truxton based on its name.
 If the <code>name</code> setting could not be found, [https://docs.python.org/3/library/constants.html#False False] will be returned.
-==<code>getinteger(name)</code>==
+==<code>getinteger(name: str) -> int</code>==
 This will retrieve an integer [[Configuration System|setting]] from Truxton based on its name.
 If the <code>name</code> setting could not be found, zero will be returned.
-==<code>getstring(name)</code>==
+==<code>getstring(name: str) -> str</code>==
 This will retrieve a string [[Configuration System|setting]] from Truxton based on its name.
 If the <code>name</code> setting could not be found, an empty string will be returned.

@@ Line 13: / Line 13: @@
 =Sample=
-<source lang="Python" highlight="4,6-8">
+<source lang="Python" highlight="6,8-10">
 import truxton

TruxtonOptions - Revision history

Sam: /* Sample */

Sam at 21:04, 16 September 2022

Sam at 11:50, 29 July 2022

Sam at 14:49, 5 March 2021

Sam: /* Sample */

Sam: /* Sample */

Sam: Created page with "This class gives you access to configuration variables. =Methods= ==getbool(name)== This will retrieve a boolean setting from Truxton..."

Sam: Created page with "This class gives you access to configuration variables. =Methods= ==`getbool(name)`== This will retrieve a boolean setting from Truxton..."