Section
section.models#
Models for managing audio files used in experiments
Our examples will assume that a playlist with the following csv data has been added to an empty database:
(
"Lion King,Hakuna Matata,0.0,10.0,/my/experiment/lionking1.mp3,Disney,happy"
"Lion King,Hakuna Matata,30.0,10.0,/my/experiment/lionking2.mp3,Disney,happy"
"Frozen,Let It Go,0.0,10.0,/my/experiment/frozen1.mp3,Disney,sad"
"Frozen,Let It Go,30.0,10.0,/my/experiment/frozen2.mp3,Disney,sad"
"West Side Story,America,0.0,10.0,/my/experiment/westsidestory1.mp3,Musical,happy"
"West Side Story,America,30.0,10.0,/my/experiment/westsidestory2.mp3,Musical,happy"
"Porgy & Bess,Summertime,0.0,10.0,/my/experiment/porgyandbess1.mp3,Musical,sad"
"Porgy & Bess,Summertime,30.0,10.0,/my/experiment/porgyandbess2.mp3,Musical,sad"
)
Playlist
#
Bases: Model
A model defining a list of sections to be played in a Block
Attributes:
Name | Type | Description |
---|---|---|
name |
str
|
playlist name |
url_prefix |
str
|
prefix for sections served from an external site |
process_csv |
bool
|
whether a csv file should be processed to create or edit this playlist |
csv |
str
|
a csv file which can be processed to create or edit this playlist |
Source code in section/models.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
|
get_section(filter_by={}, exclude={}, song_ids=[])
#
Get a random section from this playlist
Optionally, limit to specific song_ids and filter conditions
filter_by
and exclude
use Django’s querying syntax
Attributes:
Name | Type | Description |
---|---|---|
filter_by |
a dictionary defining conditions a section should meet |
|
exclude |
a dictionary defining conditions by which to exclude sections from selection |
|
song_ids |
a list of identifiers of |
Examples:
>>> playlist.get_section(exclude={'group': 'Disney})
West Side Story - America (0.0 - 10.0) OR West Side Story - America (30.0 - 40.0) OR
Porgy and Bess - Summertime (0.0 - 10.0) OR Porgy and Bess - Summertime (30.0 - 40.0)
>>> example_playlist.get_section({'tag': 'happy', 'start_time__gt': 20.0})
West Side Story - America (30.0 - 40.0) OR Lion King - Hakuna Matata (30.0 - 40.0)
>>> playlist.get_section(song_ids=[1])
Frozen - Let It Go (0.0 - 10.0) OR Frozen - Let It Go (30.0 - 40.0)
Source code in section/models.py
Section
#
Bases: Model
A snippet/section of a song, belonging to a Playlist
Attributes:
Name | Type | Description |
---|---|---|
playlist |
Playlist
|
a Many-To-One relationship to a Playlist object |
song |
Song
|
a Many-To-One relationship to a Playlist object (can be null) |
start_time |
float
|
the start time of the section in seconds, typically 0.0 |
duration |
float
|
the duration of the section in seconds, typically the duration of the audio file |
filename |
str
|
the filename on the local file system or a link to an external file |
play_count |
int
|
a counter for how often a given section has been played |
tag |
str
|
a string with which to categorize the section |
group |
str
|
another string with which to categorize the section |
Examples:
After adding the example playlist, the database would contain 8 Section objects
Source code in section/models.py
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 |
|
absolute_url()
#
Returns:
Type | Description |
---|---|
str
|
a url consisting of the BASE_URL configured for Django, plus the filename |
Source code in section/models.py
add_play_count()
#
artist_name(placeholder='')
#
Attributes:
Name | Type | Description |
---|---|---|
placeholder |
a placeholder in case the section does not have an associated Song |
Returns:
Type | Description |
---|---|
str
|
artist of associated song or placeholder |
Source code in section/models.py
end_time_str()
#
Returns:
Type | Description |
---|---|
str
|
the end time in minutes:seconds.milliseconds format |
song_label()
#
Returns:
Type | Description |
---|---|
str
|
formatted artist and name of associated song, if available |
song_name(placeholder='')
#
Attributes:
Name | Type | Description |
---|---|---|
placeholder |
a placeholder in case the section does not have an associated Song |
Returns:
Type | Description |
---|---|
str
|
name of associated song or placeholder |
Source code in section/models.py
start_time_str()
#
Returns:
Type | Description |
---|---|
str
|
the start time in minutes:seconds.milliseconds format |
Song
#
Bases: Model
A Song object with an artist and name, artist / name combinations must be unique
Attributes:
Name | Type | Description |
---|---|---|
artist |
str
|
the artist of a song |
name |
str
|
the name of a song |
Examples:
After adding the example playlist, the database would contain 4 Song objects