YAML-StructuredData
5.1.1
Installing StructuredData
Parts of StructuredData
Requirements
Install from pypi with pip
Install from source (tar.gz or zip file)
Install as root to default directories
Install to a separate directory
Install in your home
Introduction
What is StructuredData ?
The concept
What kind of data can be stored ?
How is the data stored ?
How do I address parts of the data ?
How can I test the validity of the data ?
The software package
What does it do ?
Do I always have to use the software package ?
Applications of StructuredData
Where can StructuredData be useful ?
How does StructuredData support collaboration ?
Can graphs be represented in StructuredData ?
Can trees be represented in StructuredData ?
Can the data of a relational database represented in StructuredData ?
Comparisons to other concepts
Advantages of StructuredData compared to a database
Advantages of StructuredData compared to other text file formats
Reference
StructuredData in general
StructuredData terminology
References and links
Relation of Structured Data to python data structures
Paths
Joining a keylist to a path
Escape rules
Example
Patterns
Example
StructuredDataStore
StructuredDataTypes
Differences to programming language type declarations
Typepatterns
Typepattern matching
Type declarations
boolean
integer
real
string
optional struct
open struct
struct
typed map
map
optional list
typed list
list
StructuredDataContainer
SDpyshell
Introduction
Basic Syntax
function calls
procedure calls
string literals
Basic function
Command layers
Format Specifications
Structure Formats
Text formats
Marking links
Flat format
Dry run
Commands and Functions
Generic functions
help
help()
txt.help()
fun.help()
SDtype
fun.SDtype()
String and path functions
format
format()
txt.format()
string2pathkey
string2pathkey()
txt.string2pathkey()
fun.string2pathkey()
pathkey2string
pathkey2string()
txt.pathkey2string()
fun.pathkey2string()
splitpath
splitpath()
txt.splitpath()
fun.splitpath()
joinpath
joinpath()
txt.joinpath()
fun.joinpath()
combinepaths
combinepaths()
txt.combinepaths()
fun.combinepaths()
addpaths
addpaths()
txt.addpaths()
fun.addpaths()
poppath
poppath()
txt.poppath()
fun.poppath()
substpath
substpath()
txt.substpath()
fun.substpath()
Functions for the StructuredDataContainer
newsdc
fun.newsdc()
namedsdc
fun.namedsdc()
locksdc
fun.locksdc()
copy
copy()
txt.copy()
fun.copy()
File I/O
lockfile
fun.lockfile()
lockdir
fun.lockdir()
read
read()
txt.read()
fun.read()
write
write()
txt.write()
fun.write()
rewrite
rewrite()
Printing
pr
pr()
Generic functions for the StructuredDataStore
clear_store
clear_store()
txt.clear_store()
fun.clear_store()
refresh_links
refresh_links()
txt.refresh_links()
fun.refresh_links()
Generic functions for StructuredDataTypes
clear_types
clear_types()
txt.clear_types()
fun.clear_types()
Querying the data
paths
paths()
txt.paths()
fun.paths()
find
find()
txt.find()
fun.find()
ifind
ifind()
txt.ifind()
fun.ifind()
rxfind
rxfind()
txt.rxfind()
fun.rxfind()
findval
findval()
txt.findval()
fun.findval()
ifindval
ifindval()
txt.ifindval()
fun.ifindval()
rxfindval
rxfindval()
txt.rxfindval()
fun.rxfindval()
get
get()
txt.get()
fun.get()
getlinks
getlinks()
txt.getlinks()
fun.getlinks()
findlinks
findlinks()
txt.findlinks()
fun.findlinks()
Modifying the data
filter_out
filter_out()
txt.filter_out()
fun.filter_out()
change
change()
txt.change()
fun.change()
put
put()
txt.put()
fun.put()
delete
delete()
txt.delete()
fun.delete()
link
link()
txt.link()
fun.link()
Querying types
typepaths
typepaths()
txt.typepaths()
fun.typepaths()
typefind
typefind()
txt.typefind()
fun.typefind()
typeget
typeget()
txt.typeget()
fun.typeget()
Modifying types
typeput
typeput()
txt.typeput()
fun.typeput()
typeadditem
typeadditem()
txt.typeadditem()
fun.typeadditem()
typedelete
typedelete()
txt.typedelete()
fun.typedelete()
typedeleteitem
typedeleteitem()
txt.typedeleteitem()
fun.typedeleteitem()
Typechecking
typecheck
typecheck()
txt.typecheck()
fun.typecheck()
typematch
typematch()
txt.typematch()
fun.typematch()
Command aliases
Invoking SDpyshell
Precommands
Extensions
Server mode
Server password
Process management
SDpyshell Examples
Start the SDpyshell and read the data file
Reports with get
Reports with find
Reports with rxfind
Reports with findval
Reports with rxfindval
Reports with pr
Changing a single value with change
Adding a value with put
Working with links
Working with types
A change of many parameters with export and re-import
Converting a python structure to StructuredData
Converting a perl structure to StructuredData
SDxmlrpc
Introduction
What is XML-RPC ?
What is the difference between SDxmlrpc and SDpyshell ?
Basic function
The StructuredDataContainer key
Return values
Functions
Examples
Python
Perl
C
C++
Invoking SDxmlrpc
Precommands
Extensions
Process management
Restarting the server
SDview
Introduction
The start screen
The tree frame
The tree display frame
collapse all
expand all
collapse
expand
The search frame
The search type
pattern
ipattern
regexp
find value
ipattern find value
regexp find value
report only leaves
result window
no
show paths
show paths and values
Various ways of accessing the data
An example with SDpyshell
An example using the SDshellib
An example using StructuredData.Classes
An example with python and pure yaml
An example with perl and pure yaml
Python Modules
SDshelllib
SDshelllibTxt
SDshelllibFun
SDshelllibBase
SDshellrpclib
Classes
StructuredData License
YAML-StructuredData
»
Index
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
A
add() (StructuredData.Classes.MatchPaths method)
(StructuredData.Classes.StructuredDataContainer method)
(StructuredData.Classes.StructuredDataStore method)
(StructuredData.Classes.StructuredDataTypes method)
add_locked_dir() (in module StructuredData.SDshelllibBase)
add_locked_file() (in module StructuredData.SDshelllibBase)
add_yaml_file() (StructuredData.Classes.StructuredDataContainer method)
add_yaml_string() (StructuredData.Classes.StructuredDataContainer method)
addpaths() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
aligned() (in module StructuredData.SDshelllibBase)
andmatch() (in module StructuredData.Classes)
annotated_join_path() (StructuredData.Classes.StructuredDataStore method)
append_path() (StructuredData.Classes.StructuredDataStore static method)
as_csv() (in module StructuredData.SDshelllibBase)
(StructuredData.Classes.StructuredDataStore method)
as_dict() (StructuredData.Classes.StructuredDataContainer method)
(StructuredData.Classes.StructuredDataStore method)
as_flat_dict() (StructuredData.Classes.StructuredDataStore method)
as_path_dict() (StructuredData.Classes.MatchPaths method)
(StructuredData.Classes.StructuredDataTypes method)
as_yaml_file() (StructuredData.Classes.StructuredDataContainer method)
as_yaml_string() (StructuredData.Classes.StructuredDataContainer method)
C
change() (in module StructuredData.SDshelllibFun)
check() (StructuredData.Classes.SingleTypeSpec method)
(StructuredData.Classes.StructuredDataTypes method)
check_type() (in module StructuredData.Classes)
check_type_scalar() (in module StructuredData.Classes)
clear() (StructuredData.Classes.StructuredDataStore method)
clear_store() (in module StructuredData.SDshelllibFun)
(StructuredData.Classes.StructuredDataContainer method)
clear_types() (in module StructuredData.SDshelllibFun)
(StructuredData.Classes.StructuredDataContainer method)
clone() (StructuredData.Classes.MatchPaths method)
(StructuredData.Classes.StructuredDataContainer method)
(StructuredData.Classes.StructuredDataStore method)
combinepaths() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
copy() (in module StructuredData.SDshelllibFun)
D
delete() (in module StructuredData.SDshelllibFun)
delitem() (StructuredData.Classes.StructuredDataStore method)
direct_iter() (StructuredData.Classes.StructuredDataStore method)
E
error() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
escape_in_stringkey() (in module StructuredData.Classes)
F
filter_out() (in module StructuredData.SDshelllibFun)
find() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
findlinks() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
findval() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
format() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibTxt)
from_flat_dict() (StructuredData.Classes.StructuredDataStore static method)
from_yaml_file() (StructuredData.Classes.StructuredDataContainer static method)
from_yaml_string() (StructuredData.Classes.StructuredDataContainer static method)
G
get() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
get_links() (StructuredData.Classes.StructuredDataStore method)
getlinks() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
global_sym() (in module StructuredData.SDshelllibFun)
H
h() (in module StructuredData.SDshelllib)
help() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
I
i_search() (StructuredData.Classes.StructuredDataStore method)
ifind() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
ifindval() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
imatch() (in module StructuredData.Classes)
internal_find() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
internal_findval() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
is_iterable() (in module StructuredData.Classes)
is_linked() (StructuredData.Classes.StructuredDataStore method)
is_readonly() (in module StructuredData.SDshelllibBase)
is_recursive_wildcard() (StructuredData.Classes.SpecialKey static method)
is_root() (StructuredData.Classes.SpecialKey method)
items() (StructuredData.Classes.SingleTypeSpec method)
iterator_add() (StructuredData.Classes.MatchPaths method)
(StructuredData.Classes.StructuredDataTypes method)
J
join_path() (StructuredData.Classes.StructuredDataStore static method)
joinpath() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
K
keylist2object() (StructuredData.Classes.StructuredDataStore method)
keylist_set() (StructuredData.Classes.StructuredDataStore method)
keysubst() (StructuredData.Classes.SpecialKey static method)
L
link() (in module StructuredData.SDshelllibFun)
(StructuredData.Classes.StructuredDataStore method)
links_keylist_sets() (StructuredData.Classes.StructuredDataStore method)
links_path_sets() (StructuredData.Classes.StructuredDataStore method)
list_match() (StructuredData.Classes.SpecialKey static method)
listdelitem() (StructuredData.Classes.StructuredDataStore method)
listsetitem() (StructuredData.Classes.StructuredDataStore method)
lock() (StructuredData.Classes.MatchPaths method)
(StructuredData.Classes.StructuredDataContainer method)
(StructuredData.Classes.StructuredDataStore method)
lockdir() (in module StructuredData.SDshelllibFun)
lockfile() (in module StructuredData.SDshelllibFun)
locksdc() (in module StructuredData.SDshelllibFun)
M
m_direct_iter() (StructuredData.Classes.MatchPaths method)
match() (StructuredData.Classes.MatchPaths method)
(StructuredData.Classes.SpecialKey method)
MatchPaths (class in StructuredData.Classes)
meta() (StructuredData.Classes.StructuredDataContainer method)
module
StructuredData.Classes
StructuredData.SDshelllib
StructuredData.SDshelllibBase
StructuredData.SDshelllibFun
StructuredData.SDshelllibTxt
StructuredData.SDshellrpclib
module_functions() (in module StructuredData.SDshelllibBase)
multi() (in module StructuredData.SDshelllibBase)
MultiStringOption (class in StructuredData.SDshelllibBase)
N
namedsdc() (in module StructuredData.SDshelllibFun)
newsdc() (in module StructuredData.SDshelllibFun)
P
p() (in module StructuredData.SDshelllib)
parse() (StructuredData.SDshelllibBase.MultiStringOption method)
path2object() (StructuredData.Classes.StructuredDataStore method)
pathkey2string() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
paths() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
pattern_get_links() (StructuredData.Classes.StructuredDataStore method)
pickle() (StructuredData.Classes.StructuredDataContainer method)
poppath() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
pr() (in module StructuredData.SDshelllib)
prettyprint() (in module StructuredData.SDshelllibBase)
put() (in module StructuredData.SDshelllibFun)
py() (in module StructuredData.SDshelllibBase)
R
r() (in module StructuredData.SDshelllib)
read() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
read_py() (in module StructuredData.SDshelllibBase)
recursive_wildcard() (StructuredData.Classes.SpecialKey method)
refresh_links() (in module StructuredData.SDshelllibFun)
(StructuredData.Classes.StructuredDataStore method)
regexp_search() (StructuredData.Classes.StructuredDataStore method)
rewrite() (in module StructuredData.SDshelllib)
rw() (in module StructuredData.SDshelllib)
rxfind() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
rxfindval() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
S
sdc_get() (in module StructuredData.SDshelllibFun)
sdc_register() (in module StructuredData.SDshelllibFun)
SDtype() (in module StructuredData.SDshelllibFun)
selection_iter() (StructuredData.Classes.StructuredDataStore method)
set_store() (StructuredData.Classes.StructuredDataContainer method)
set_types() (StructuredData.Classes.StructuredDataContainer method)
setitem() (StructuredData.Classes.StructuredDataStore method)
setitems() (StructuredData.Classes.StructuredDataStore method)
simple_search() (StructuredData.Classes.MatchPaths method)
(StructuredData.Classes.StructuredDataStore method)
simple_wildcard() (StructuredData.Classes.SpecialKey method)
SingleTypeSpec (class in StructuredData.Classes)
SpecialKey (class in StructuredData.Classes)
split_path() (StructuredData.Classes.StructuredDataStore static method)
splitpath() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
store() (StructuredData.Classes.StructuredDataContainer method)
string2pathkey() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
string_to_keyobject() (in module StructuredData.Classes)
struc2sym() (in module StructuredData.SDshelllibFun)
StructuredData.Classes
module
StructuredData.SDshelllib
module
StructuredData.SDshelllibBase
module
StructuredData.SDshelllibFun
module
StructuredData.SDshelllibTxt
module
StructuredData.SDshellrpclib
module
StructuredDataContainer (class in StructuredData.Classes)
StructuredDataStore (class in StructuredData.Classes)
StructuredDataTypes (class in StructuredData.Classes)
substpath() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
sym2struc() (in module StructuredData.SDshelllibFun)
T
to_dict() (StructuredData.Classes.SingleTypeSpec method)
typeadditem() (in module StructuredData.SDshelllibFun)
typecheck() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(StructuredData.Classes.StructuredDataContainer method)
typedelete() (in module StructuredData.SDshelllibFun)
typedeleteitem() (in module StructuredData.SDshelllibFun)
typefind() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
typeget() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
typematch() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
typepaths() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
(in module StructuredData.SDshelllibTxt)
typeput() (in module StructuredData.SDshelllibFun)
types() (StructuredData.Classes.StructuredDataContainer method)
U
unescape_in_stringkey() (in module StructuredData.Classes)
universal_iter() (StructuredData.Classes.StructuredDataStore method)
unpickle() (StructuredData.Classes.StructuredDataContainer static method)
update() (StructuredData.Classes.StructuredDataStore method)
use_file_lock() (in module StructuredData.SDshelllibBase)
V
value_i_search() (StructuredData.Classes.StructuredDataStore method)
value_regexp_search() (StructuredData.Classes.StructuredDataStore method)
value_search() (StructuredData.Classes.StructuredDataStore method)
W
w() (in module StructuredData.SDshelllib)
write() (in module StructuredData.SDshelllib)
(in module StructuredData.SDshelllibFun)
write_yml() (in module StructuredData.SDshelllibBase)
Y
yaml() (in module StructuredData.SDshelllibBase)