mousepy.api.recordings.properties package¶

Submodules¶

mousepy.api.recordings.properties.bulktag module¶

class mousepy.api.recordings.properties.bulktag.BulkTag(parent: mousepy.api.API, tag_name: str)[source]¶

Bases: mousepy.api.API

Allows for bulk listing, creation and removal of tags

add(to: list)[source]¶

Parameters:	to – List of recording ids to add the tag to
Returns:	`BulkTag`

remove(ids: list)[source]¶

Parameters:	ids – List of recording ids to remove the tag from
Returns:	`BulkTag`

mousepy.api.recordings.properties.star module¶

class mousepy.api.recordings.properties.star.Star(parent)[source]¶

Bases: mousepy.api.API

remove()[source]¶

Returns:	`Star`

run()[source]¶

Returns:	`Star`

mousepy.api.recordings.properties.tag module¶

class mousepy.api.recordings.properties.tag.Tag(parent, tag_name)[source]¶

Bases: mousepy.api.API

Allows for the listing, creation and removal of tags

add()[source]¶

Returns:	`Tag`

remove()[source]¶

Returns:	`Tag`

mousepy.api.recordings.properties.tags module¶

class mousepy.api.recordings.properties.tags.Tags(parent)[source]¶

Bases: mousepy.api.API

List all available tags

list() → list[source]¶

Returns:	list

mousepy.api.recordings.properties.variables module¶

class mousepy.api.recordings.properties.variables.Variables(parent, **kwargs)[source]¶

Bases: mousepy.api.API

Listing and creation of recording variables

create()[source]¶

Returns:	`Variables`

delete()[source]¶

Returns:	`Variables`

Module contents¶

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.