Contest schema#
contest.rbx.yml#
Contest
#
Bases: BaseModel
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
use_variants
|
bool
|
When true, this file is a sentinel marking the directory as a multi-contest dispatcher. The actual contests live in sibling files matching contest. |
False
|
name
|
str
|
Name of this contest. |
''
|
titles
|
Dict[str, str]
|
Titles for the contest in each language. Languages should be specified as lowercase ISO 639-1 codes. |
{}
|
languages
|
List[str] | None
|
Languages this package ships statements in, as lowercase ISO 639-1 codes. Statements declared with |
None
|
problems
|
List[ContestProblem]
|
List of problems in this contest. |
[]
|
statements
|
List[ContestStatement]
|
Configure statements in this contest, per language. |
[]
|
tutorials
|
List[ContestStatement]
|
Configure tutorials (editorials) in this contest, per language. |
[]
|
documents
|
List[Document]
|
Configure standalone documents (infosheets, etc.) for this contest. Documents never join on problems. |
[]
|
issues
|
IssuesConfig
|
Which issues to report for every problem of this contest. A problem's own |
<dynamic>
|
vars
|
RecVars
|
Variables to be re-used across the package. |
{}
|
extensions
|
ContestExtensions | None
|
Settings for the judges this contest is exported to. |
None
|
Source code in rbx/box/contest/schema.py
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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 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 | |
effective_languages
#
The languages wildcard entries expand to: languages:, else the
distinct languages of the concrete entries in order of appearance.
ContestExtensions
#
Bases: BaseModel
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
cms
|
CmsExtension | None
|
CMS contest and task settings. They override the ones in |
None
|
Source code in rbx/box/contest/schema.py
ContestProblem
#
Bases: BaseModel
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
short_name
|
str
|
Short name of the problem. Usually, just an uppercase letter, but can be a sequence of uppercase letters followed by a number. |
required |
aliases
|
List[str]
|
Optional list of aliases for this problem. You can refer to the problem by its
short_name or by any of these aliases in commands such as [item]rbx on |
<dynamic>
|
path
|
Path | None
|
Path to the problem relative to the contest package directory. If not specified, will expect the problem to be in ./{short_name}/ folder. |
None
|
color
|
str | None
|
Color that represents this problem in the contest. Can be a hex color (#abcdef or #abc format), or a color name among available X11 colors. See https://en.wikipedia.org/wiki/X11_color_names for the list of supported color names. |
None
|
colorName
|
str | None
|
A custom color name for the color provided by this problem. If not provided, will try to infer a color name from the color provided. |
None
|
Source code in rbx/box/contest/schema.py
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 | |
all_identifiers()
#
All names that can be used to refer to this problem (short_name + aliases), lowercased.
ContestStatement
#
Bases: BaseStatement
A contest-level statement. Owns the templates used to render problems both standalone and inside the contest join (design §3.2).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of this statement. Unique within the contest. May carry |
required |
extends
|
str | None
|
Name of the contest statement to inherit the build recipe from. |
None
|
standaloneProblemTemplate
|
Path | None
|
Template applied to build a problem-level statement as a standalone document ( |
None
|
contestProblemTemplate
|
Path | None
|
Template applied to build the problem fragment that gets imported into the contest statement ( |
None
|
Source code in rbx/box/contest/schema.py
Document
#
Bases: BaseStatement
A contest-level document (infosheet, etc.). Shares the statement model but NEVER joins on problems, so it is restricted to non-rbx types (design §3.2).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str
|
Name of this document. Unique within the contest. May carry |
required |
extends
|
str | None
|
Name of the document to inherit the build recipe from. |
None
|