Folder

class wwt_data_formats.folder.Folder(**kwargs)

Bases: wwt_data_formats.LockedXmlTraits, wwt_data_formats.abcs.UrlContainer

A grouping of WWT content assets.

Children can be: places (aka “Items”), imagesets, linesets, tours, folders, or IThumbnail objects (to be explored).

Attributes Summary

browseable	A boolean (True, False) trait.
children	An instance of a Python list.
group	A trait for unicode strings.
msr_community_id	The ID number of the WWT Community that this content came from.
msr_component_id	The ID number of this content item on the WWT Communities system.
name	A trait for unicode strings.
permission	TBD.
searchable	A boolean (True, False) trait.
sub_type	A trait for unicode strings.
thumbnail	A trait for unicode strings.
type	Use a Enum class as model for the data type description.
url	The URL at which the full contents of this folder can be downloaded in WTML format.

Methods Summary

walk([download])

Attributes Documentation

browseable

A boolean (True, False) trait.

children

An instance of a Python list.

group

A trait for unicode strings.

msr_community_id

The ID number of the WWT Community that this content came from.

msr_component_id

The ID number of this content item on the WWT Communities system.

name

A trait for unicode strings.

permission

TBD.

searchable

A boolean (True, False) trait.

sub_type

A trait for unicode strings.

thumbnail

A trait for unicode strings.

type

Use a Enum class as model for the data type description. Note that if no default-value is provided, the first enum-value is used as default-value.

# -- SINCE: Python 3.4 (or install backport: pip install enum34)
import enum
from traitlets import HasTraits, UseEnum

class Color(enum.Enum):
    red = 1         # -- IMPLICIT: default_value
    blue = 2
    green = 3

class MyEntity(HasTraits):
    color = UseEnum(Color, default_value=Color.blue)

entity = MyEntity(color=Color.red)
entity.color = Color.green    # USE: Enum-value (preferred)
entity.color = "green"        # USE: name (as string)
entity.color = "Color.green"  # USE: scoped-name (as string)
entity.color = 3              # USE: number (as int)
assert entity.color is Color.green

url

The URL at which the full contents of this folder can be downloaded in WTML format.

Methods Documentation

walk(download=False)