cli.sync_acls Namespace Reference

Functions
Path	is_directory (str path_str)
list[AclEntry]	collect_acls (Path root, bool cross_volume=False)
def	update_acls (Path dest, list[AclEntry] acls, bool dry_run=True)
int	main ()

Variables
	parser = argparse.ArgumentParser()
	action
	help
	metavar
	type
	default
dictionary	CODA_ACLS_SCHEMA

Function Documentation

collect_acls()

list[AclEntry] cli.sync_acls.collect_acls	(	Path	root,
		bool	cross_volume = False
	)

Walk directory tree in Coda, collecting ACLs

is_directory()

Path cli.sync_acls.is_directory

(

str

path_str

)

To make sure the destination argument is a directory

main()

int cli.sync_acls.main

(

void

)

Copy acls from a source yaml file, or directories in Coda, to
destination directories in Coda or write to a new yaml file.

update_acls()

def cli.sync_acls.update_acls	(	Path	dest,
		list[AclEntry]	acls,
		bool	dry_run = True
	)

Update Coda ACLs under 'dest'

Variable Documentation

action

cli.sync_acls.action

CODA_ACLS_SCHEMA

dictionary cli.sync_acls.CODA_ACLS_SCHEMA

Initial value:

=  {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://coda.cs.cmu.edu/schemas/coda_acls.json",
    "$defs": {
        "fspath": {"type": "string"},
        "user_or_group": {"type": "string"},
        "acl_rights": {"type": "string", "pattern": "^-?r?l?i?d?w?k?a?$"},
        "acl_entry": {
            "type": "object",
            "properties": {
                "name": {"$ref": "#/$defs/user_or_group"},
                "rights": {"$ref": "#/$defs/acl_rights"},
            },
            "required": ["name", "rights"],
        },
        "acl": {
            "type": "object",
            "properties": {
                "path": {"$ref": "#/$defs/fspath"},
                "acl": {"type": "array", "items": {"$ref": "#/$defs/acl_entry"}},
            },
            "required": ["path", "acl"],
        },
    },
    "type": "object",
    "properties": {"acls": {"type": "array", "items": {"$ref": "#/$defs/acl"}}},
    "required": ["acls"],
}

default

cli.sync_acls.default

help

cli.sync_acls.help

metavar

cli.sync_acls.metavar

parser

cli.sync_acls.parser = argparse.ArgumentParser()

type

cli.sync_acls.type