Class RESTBase

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__

(inherited documentation)

This method is used to set a property, a resource or a list of resources as property of the resource the method is invoked on.

For example, to set a comment on a track, do

>>> sca = scapi.Scope(connector)
>>> track = scapi.Track.new(title='bar', sharing="private")
>>> comment = scapi.Comment.create(body="This is the body of my comment", timestamp=10)    
>>> track.comments = comment

To set a list of users as permissions, do

>>> sca = scapi.Scope(connector)
>>> me = sca.me()
>>> track = scapi.Track.new(title='bar', sharing="private")
>>> users = sca.users()
>>> users_to_set = [user  for user in users[:10] if user != me]
>>> track.permissions = users_to_set

And finally, to simply change the title of a track, do

>>> sca = scapi.Scope(connector)
>>> track = sca.Track.get(track_id)
>>> track.title = "new_title"

Parameters:

• name (str) - the property name
• value (RESTBase | list<RESTBase> | basestring | long | int | float) - the property, resource or resources to set

Returns:

None

Overrides: object.__setattr__

This is a convenience-method for creating an object that will be passed as parameter - e.g. a comment. A usage would look like this:

>>> sca = scapi.Scope(connector)
>>> track = sca.Track.new(title='bar', sharing="private")
>>> comment = sca.Comment.create(body="This is the body of my comment", timestamp=10)    
>>> track.comments = comment

Create a new resource inside a given Scope. The actual values are in data.

So for creating new resources, you have two options:

• create an instance directly using the class:

  >>> scope = scapi.Scope(connector)
  >>> scope.User.new(...)
  <scapi.User object at 0x1234>

• create a instance in a certain scope:

  >>> scope = scapi.Scope(connector)
  >>> user = scapi.User("1")
  >>> track = user.tracks.new()
  <scapi.Track object at 0x1234>

Parameters:

• scope (tuple<Scope>[1]) - if not empty, a one-element tuple containing the Scope
• data (dict) - the data

Returns:

new instance of the resource

Fetch a resource by id.

Simply pass a known id as argument. For example

>>> sca = scapi.Scope(connector)
>>> track = sca.Track.get(id)

repr(x)

Overrides: object.__repr__

(inherited documentation)

hash(x)

Overrides: object.__hash__

(inherited documentation)

Test for equality.

Resources are considered equal if the have the same kind and id.

REGISTRY

Value:

{'comments': <class 'scapi.Comment'>, 'contacts': <class 'scapi.User'>, 'events': <class 'scapi.Event'>, 'favorites': <class 'scapi.Track'>, 'groups': <class 'scapi.Group'>, 'me': <class 'scapi.User'>, 'permissions': <class 'scapi.User'>, 'playlists': <class 'scapi.Playlist'>, ...

ALL_DOMAIN_CLASSES

Value:

{'Comment': <class 'scapi.Comment'>, 'Event': <class 'scapi.Event'>, 'Group': <class 'scapi.Group'>, 'Playlist': <class 'scapi.Playlist'>, 'Track': <class 'scapi.Track'>, 'User': <class 'scapi.User'>}