brane
Introduction
What is brane ?
What will brane solves ?
What does brane means ?
Features of brane
Unified I/O interface
Hook system
I/O tracking
Examples
Package overview tour
Read / Write operations via eXtended-I/O
text
csv
Customization
Define own module
Define new Module subclass
Define new Format subclass
Define new Object subclass
Hook system
Check the pre-existing hooks
Add new hook
API
brane package
Subpackages
brane.config package
Module contents
brane.core package
Submodules
brane.core.base module
brane.core.event module
brane.core.factory module
brane.core.format module
brane.core.hook module
brane.core.mapper module
brane.core.module module
brane.core.object module
brane.core.utils module
brane.core.xio module
Module contents
brane.libs package
Subpackages
Module contents
Submodules
brane.typing module
Module contents
brane
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
A
action (brane.core.event.MarkerRule attribute)
activate (brane.typing.HookClassType attribute)
activate() (brane.core.factory.BraneClassGenerator class method)
(brane.core.factory.BraneHooksGenerator class method)
(brane.core.hook.Hook method)
active (brane.core.hook.Hook property)
(brane.typing.HookClassType attribute)
add_hooks (brane.typing.EventClassType attribute)
add_hooks() (brane.core.event.Event method)
add_marker_rule() (brane.core.event.Event method)
all_formats() (brane.core.xio.ExtendedIO class method)
all_modules() (brane.core.xio.ExtendedIO class method)
all_objects() (brane.core.xio.ExtendedIO class method)
args (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
B
base_args_read (brane.core.module.ModuleConfig attribute)
base_args_write (brane.core.module.ModuleConfig attribute)
base_kwargs_read (brane.core.module.ModuleConfig attribute)
base_kwargs_write (brane.core.module.ModuleConfig attribute)
BaseSubclassRegister (class in brane.core.base)
brane
module
brane.config
module
brane.core
module
brane.core.base
module
brane.core.event
module
brane.core.factory
module
brane.core.format
module
brane.core.hook
module
brane.core.mapper
module
brane.core.module
module
brane.core.object
module
brane.core.utils
module
brane.core.xio
module
brane.libs
module
brane.libs.hooks
module
brane.libs.hooks.core
module
brane.libs.hooks.image
module
brane.typing
module
BraneClassGenerator (class in brane.core.factory)
BraneHooksGenerator (class in brane.core.factory)
C
check_extension (brane.core.format.NoneFormat attribute)
(brane.typing.FormatClassType attribute)
check_extension() (brane.core.format.Format class method)
check_marker() (brane.core.event.Event method)
check_path_existence() (in module brane.libs.hooks.core)
className2Format (brane.core.factory.BraneClassGenerator attribute)
className2Module (brane.core.factory.BraneClassGenerator attribute)
className2Object (brane.core.factory.BraneClassGenerator attribute)
clean_marker_rules() (brane.core.event.Event method)
clear_all_hooks() (brane.core.xio.HookManager class method)
clear_hooks (brane.typing.EventClassType attribute)
clear_hooks() (brane.core.event.Event method)
(brane.core.xio.HookManager static method)
clear_post_read_hook() (brane.core.xio.HookManager class method)
clear_post_readall_hook() (brane.core.xio.HookManager class method)
clear_post_write_hook() (brane.core.xio.HookManager class method)
clear_post_writeall_hook() (brane.core.xio.HookManager class method)
clear_pre_read_hook() (brane.core.xio.HookManager class method)
clear_pre_readall_hook() (brane.core.xio.HookManager class method)
clear_pre_write_hook() (brane.core.xio.HookManager class method)
clear_pre_writeall_hook() (brane.core.xio.HookManager class method)
condition (brane.typing.HookClassType attribute)
condition() (brane.core.hook.FunctionHook method)
(brane.core.hook.Hook method)
(brane.libs.hooks.image.PILResizeHook method)
connect_hook_and_event() (brane.core.xio.HookManager class method)
Context (class in brane.core.base)
ContextInterface (class in brane.typing)
convert_obj_into_list() (in module brane.core.event)
create_parent_directory() (in module brane.libs.hooks.core)
D
deactivate (brane.typing.HookClassType attribute)
deactivate() (brane.core.hook.Hook method)
default_extension (brane.core.format.Format attribute)
(brane.core.format.FormatConfig attribute)
E
Event (class in brane.core.event)
event2hooks (brane.core.factory.BraneHooksGenerator attribute)
EventClassType (class in brane.typing)
ext (brane.core.base.Context attribute)
(brane.typing.ContextInterface attribute)
ExtendedIO (class in brane.core.xio)
ExtensionMapper (class in brane.core.mapper)
F
file (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
file_arg_first (brane.core.module.ModuleConfig attribute)
file_keyword_at_write (brane.core.module.ModuleConfig attribute)
file_open_for_read (brane.core.module.ModuleConfig attribute)
file_open_for_write (brane.core.module.ModuleConfig attribute)
file_read_method_name (brane.core.module.ModuleConfig attribute)
file_write_method_name (brane.core.module.ModuleConfig attribute)
files (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
fire() (brane.core.event.Event method)
Format (brane.core.base.Context attribute)
,
[1]
format (brane.core.object.Object attribute)
Format (brane.typing.ContextInterface attribute)
format (brane.typing.ObjectClassType attribute)
Format (class in brane.core.format)
format_checker (brane.core.object.Object attribute)
(brane.typing.ObjectClassType attribute)
format_name (brane.core.object.ObjectConfig attribute)
FormatClassType (class in brane.typing)
FormatConfig (class in brane.core.format)
FormatConfigType (class in brane.core.factory)
FormatTemplate (class in brane.core.format)
FunctionHook (class in brane.core.hook)
G
generate_classes_from_configs() (brane.core.factory.BraneClassGenerator static method)
generate_hash_from_objects() (in module brane.core.hook)
generate_params_write (brane.core.module.ModuleTemplate attribute)
get_events() (brane.core.xio.HookManager class method)
get_extension_from_filename() (brane.core.xio.ExtendedIO method)
get_extension_from_filname_default() (in module brane.core.utils)
get_format_class_from_extension() (brane.core.mapper.ExtensionMapper class method)
get_hook_names() (brane.core.event.Event method)
get_module_class_from_extension() (brane.core.mapper.ExtensionMapper class method)
get_module_from_object() (brane.core.mapper.ObjectFormat2Module method)
get_registered_subclasses() (brane.core.base.BaseSubclassRegister class method)
H
Hook (class in brane.core.hook)
hook_name (brane.core.hook.Hook attribute)
(brane.libs.hooks.image.PILResizeHook attribute)
(brane.typing.HookClassType attribute)
HookClassType (class in brane.typing)
HookConfigType (class in brane.core.factory)
HookManager (class in brane.core.xio)
I
integrate_args() (in module brane.core.utils)
integrate_kwargs() (in module brane.core.utils)
IOLogger (class in brane.core.xio)
K
kept_storage_options (brane.core.xio.ExtendedIO attribute)
kwargs (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
L
load_brane_formats() (brane.core.factory.BraneClassGenerator class method)
load_brane_modules() (brane.core.factory.BraneClassGenerator class method)
load_brane_objects() (brane.core.factory.BraneClassGenerator class method)
load_config() (in module brane.core.factory)
load_event2hooks() (brane.core.factory.BraneHooksGenerator class method)
load_hooks_from_config() (brane.core.factory.BraneHooksGenerator class method)
load_modules (brane.core.module.NoneModule attribute)
(brane.typing.ModuleClassType attribute)
load_modules() (brane.core.module.Module class method)
(brane.core.module.ModuleTemplate class method)
load_multiple_config() (in module brane.core.factory)
load_objects (brane.typing.ObjectClassType attribute)
load_objects() (brane.core.object.Object class method)
loaded (brane.core.module.Module attribute)
(brane.core.module.NoneModule attribute)
(brane.core.object.Object attribute)
(brane.typing.ModuleClassType attribute)
log (brane.core.xio.IOLogger attribute)
logger (brane.core.xio.ExtendedIO attribute)
M
marker (brane.core.event.MarkerRule attribute)
(brane.core.hook.Hook attribute)
(brane.typing.HookClassType attribute)
MarkerRule (class in brane.core.event)
MetaFalse (class in brane.core.base)
MetaFormat (class in brane.core.format)
MetaModule (class in brane.core.module)
MetaNoneFormat (class in brane.core.format)
MetaNoneModule (class in brane.core.module)
MetaObject (class in brane.core.object)
module
brane
brane.config
brane.core
brane.core.base
brane.core.event
brane.core.factory
brane.core.format
brane.core.hook
brane.core.mapper
brane.core.module
brane.core.object
brane.core.utils
brane.core.xio
brane.libs
brane.libs.hooks
brane.libs.hooks.core
brane.libs.hooks.image
brane.typing
Module (brane.core.base.Context attribute)
,
[1]
module (brane.core.format.Format attribute)
(brane.core.format.NoneFormat attribute)
(brane.core.module.ModuleTemplate attribute)
(brane.core.object.Object attribute)
Module (brane.typing.ContextInterface attribute)
module (brane.typing.FormatClassType attribute)
(brane.typing.ObjectClassType attribute)
Module (class in brane.core.module)
module_checker (brane.core.object.Object attribute)
(brane.typing.ObjectClassType attribute)
module_name (brane.core.format.FormatConfig attribute)
(brane.core.module.ModuleTemplate attribute)
(brane.core.object.ObjectConfig attribute)
module_read_method (brane.core.module.ModuleTemplate attribute)
module_read_method_name (brane.core.module.ModuleConfig attribute)
module_write_method (brane.core.module.ModuleTemplate attribute)
module_write_method_name (brane.core.module.ModuleConfig attribute)
ModuleClassType (class in brane.typing)
ModuleConfig (class in brane.core.module)
ModuleConfigType (class in brane.core.factory)
ModuleTemplate (class in brane.core.module)
N
name (brane.core.format.Format attribute)
(brane.core.format.FormatConfig attribute)
(brane.core.format.FormatTemplate attribute)
(brane.core.format.NoneFormat attribute)
(brane.core.module.Module attribute)
(brane.core.module.ModuleConfig attribute)
(brane.core.module.ModuleTemplate attribute)
(brane.core.module.NoneModule attribute)
(brane.core.object.Object attribute)
(brane.core.object.ObjectTemplate attribute)
(brane.typing.ModuleClassType attribute)
NoneFormat (class in brane.core.format)
NoneModule (class in brane.core.module)
normalize_extension_default() (in module brane.core.format)
O
obj_keyword_at_write (brane.core.module.ModuleConfig attribute)
object (brane.core.base.Context attribute)
,
[1]
(brane.core.object.MetaObject property)
(brane.typing.ContextInterface attribute)
(brane.typing.ObjectClassType attribute)
Object (class in brane.core.object)
object_transform_method_name (brane.core.module.ModuleConfig attribute)
object_type (brane.core.object.Object attribute)
(brane.core.object.ObjectTemplate attribute)
object_type_info (brane.core.object.Object attribute)
(brane.core.object.ObjectConfig attribute)
(brane.core.object.ObjectTemplate attribute)
object_unpacking_type (brane.core.module.ModuleConfig attribute)
object_write_method_name (brane.core.module.ModuleConfig attribute)
ObjectClassType (class in brane.typing)
ObjectConfig (class in brane.core.object)
ObjectConfigType (class in brane.core.factory)
ObjectFormat2Module (class in brane.core.mapper)
objects (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
ObjectTemplate (class in brane.core.object)
open_mode_for_read (brane.core.module.ModuleConfig attribute)
open_mode_for_write (brane.core.module.ModuleConfig attribute)
P
path (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
paths (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
PILResizeHook (class in brane.libs.hooks.image)
post_read (brane.core.xio.HookManager attribute)
post_readall (brane.core.xio.HookManager attribute)
post_write (brane.core.xio.HookManager attribute)
post_writeall (brane.core.xio.HookManager attribute)
pre_read (brane.core.xio.HookManager attribute)
pre_readall (brane.core.xio.HookManager attribute)
pre_write (brane.core.xio.HookManager attribute)
pre_writeall (brane.core.xio.HookManager attribute)
print() (in module brane.typing)
priority (brane.core.base.BaseSubclassRegister attribute)
(brane.core.event.MarkerRule attribute)
(brane.core.format.Format attribute)
(brane.core.format.FormatConfig attribute)
(brane.core.module.Module attribute)
(brane.core.module.ModuleConfig attribute)
(brane.core.object.Object attribute)
(brane.core.object.ObjectConfig attribute)
protocol (brane.core.base.Context attribute)
,
[1]
(brane.typing.ContextInterface attribute)
R
read (brane.core.module.NoneModule attribute)
(brane.typing.ModuleClassType attribute)
read() (brane.core.module.Module class method)
(brane.core.module.ModuleTemplate class method)
(brane.core.xio.ExtendedIO class method)
read_all_as_dict() (brane.core.xio.ExtendedIO class method)
read_all_as_list() (brane.core.xio.ExtendedIO class method)
register_post_read_hook() (brane.core.xio.HookManager class method)
register_post_readall_hook() (brane.core.xio.HookManager class method)
register_post_write_hook() (brane.core.xio.HookManager class method)
register_post_writeall_hook() (brane.core.xio.HookManager class method)
register_pre_read_hook() (brane.core.xio.HookManager class method)
register_pre_readall_hook() (brane.core.xio.HookManager class method)
register_pre_write_hook() (brane.core.xio.HookManager class method)
register_pre_writeall_hook() (brane.core.xio.HookManager class method)
registered_formats (brane.core.format.MetaFormat property)
registered_modules (brane.core.module.MetaModule property)
registered_objects (brane.core.object.MetaObject property)
reload() (brane.core.xio.ExtendedIO class method)
reload_modules (brane.core.module.NoneModule attribute)
(brane.typing.ModuleClassType attribute)
reload_modules() (brane.core.module.Module class method)
remove_hooks (brane.typing.EventClassType attribute)
remove_hooks() (brane.core.event.Event method)
(brane.core.xio.HookManager class method)
remove_hooks_for_event() (brane.core.xio.HookManager static method)
remove_marker_rule() (brane.core.event.Event method)
S
search_hook_name_with_index() (brane.core.event.Event method)
set_storage_option() (brane.core.xio.ExtendedIO class method)
setup() (brane.core.factory.BraneClassGenerator class method)
(brane.core.factory.BraneHooksGenerator class method)
setup_hooks() (brane.core.xio.HookManager class method)
show_events() (brane.core.xio.HookManager class method)
sort_mapper() (in module brane.core.utils)
T
transform (brane.core.module.ModuleTemplate attribute)
transform_info (brane.core.module.ModuleConfig attribute)
transform_name (brane.core.module.ModuleConfig attribute)
type_evaluation (brane.core.object.Object attribute)
V
valid (brane.core.base.BaseSubclassRegister attribute)
(brane.core.format.NoneFormat attribute)
(brane.core.module.NoneModule attribute)
variation (brane.core.format.Format attribute)
(brane.core.format.FormatConfig attribute)
(brane.core.format.FormatTemplate attribute)
(brane.core.format.NoneFormat attribute)
W
write (brane.core.module.NoneModule attribute)
(brane.typing.ModuleClassType attribute)
write() (brane.core.module.Module class method)
(brane.core.module.ModuleTemplate class method)
(brane.core.xio.ExtendedIO class method)
write_all_from_dict() (brane.core.xio.ExtendedIO class method)
write_all_from_list() (brane.core.xio.ExtendedIO class method)
writer_method_name (brane.core.module.ModuleConfig attribute)