Row
Bases: Mapping[str, Any]
A row is a collection of named values.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data |
Mapping[str, Any] | None
|
The data. If None, an empty row is created. |
None
|
Examples:
Source code in src/safeds/data/tabular/containers/_row.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 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 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 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 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 |
|
column_names: list[str]
property
¶
number_of_column: int
property
¶
schema: Schema
property
¶
__contains__(obj)
¶
Check whether the row contains an object as key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
obj |
Any
|
The object. |
required |
Returns:
Name | Type | Description |
---|---|---|
has_column |
bool
|
True, if the row contains the object as key, False otherwise. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1, "b": 2})
>>> "a" in row
True
Source code in src/safeds/data/tabular/containers/_row.py
__eq__(other)
¶
Check whether this row is equal to another object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
other |
Any
|
The other object. |
required |
Returns:
Name | Type | Description |
---|---|---|
equal |
bool
|
True if the other object is an identical row. False if the other object is a different row. NotImplemented if the other object is not a row. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row1 = Row({"a": 1, "b": 2})
>>> row2 = Row({"a": 1, "b": 2})
>>> row1 == row2
True
Source code in src/safeds/data/tabular/containers/_row.py
__getitem__(column_name)
¶
Return the value of a specified column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
column_name |
str
|
The column name. |
required |
Returns:
Name | Type | Description |
---|---|---|
value |
Any
|
The column value. |
Raises:
Type | Description |
---|---|
UnknownColumnNameError
|
If the row does not contain the specified column. |
Examples:
Source code in src/safeds/data/tabular/containers/_row.py
__init__(data=None)
¶
Create a row from a mapping of column names to column values.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data |
Mapping[str, Any] | None
|
The data. If None, an empty row is created. |
None
|
Examples:
Source code in src/safeds/data/tabular/containers/_row.py
__iter__()
¶
Create an iterator for the column names of this row.
Returns:
Name | Type | Description |
---|---|---|
iterator |
Iterator[Any]
|
The iterator. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1, "b": 2})
>>> list(row)
['a', 'b']
Source code in src/safeds/data/tabular/containers/_row.py
__len__()
¶
Return the number of columns in this row.
Returns:
Name | Type | Description |
---|---|---|
number_of_columns |
int
|
The number of columns. |
Examples:
Source code in src/safeds/data/tabular/containers/_row.py
__repr__()
¶
Return an unambiguous string representation of this row.
Returns:
Name | Type | Description |
---|---|---|
representation |
str
|
The string representation. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1})
>>> repr(row)
"Row({'a': 1})"
Source code in src/safeds/data/tabular/containers/_row.py
__str__()
¶
Return a user-friendly string representation of this row.
Returns:
Name | Type | Description |
---|---|---|
representation |
str
|
The string representation. |
Examples:
Source code in src/safeds/data/tabular/containers/_row.py
from_dict(data)
staticmethod
¶
Create a row from a dictionary that maps column names to column values.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data |
dict[str, Any]
|
The data. |
required |
Returns:
Name | Type | Description |
---|---|---|
row |
Row
|
The created row. |
Examples:
Source code in src/safeds/data/tabular/containers/_row.py
get_column_type(column_name)
¶
Return the type of the specified column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
column_name |
str
|
The column name. |
required |
Returns:
Name | Type | Description |
---|---|---|
type |
ColumnType
|
The type of the column. |
Raises:
Type | Description |
---|---|
UnknownColumnNameError
|
If the row does not contain the specified column. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1, "b": 2})
>>> row.get_column_type("a")
Integer
Source code in src/safeds/data/tabular/containers/_row.py
get_value(column_name)
¶
Return the value of a specified column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
column_name |
str
|
The column name. |
required |
Returns:
Name | Type | Description |
---|---|---|
value |
Any
|
The column value. |
Raises:
Type | Description |
---|---|
UnknownColumnNameError
|
If the row does not contain the specified column. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1, "b": 2})
>>> row.get_value("a")
1
Source code in src/safeds/data/tabular/containers/_row.py
has_column(column_name)
¶
Check whether the row contains a given column.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
column_name |
str
|
The column name. |
required |
Returns:
Name | Type | Description |
---|---|---|
has_column |
bool
|
True, if the row contains the column, False otherwise. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1, "b": 2})
>>> row.has_column("a")
True
Source code in src/safeds/data/tabular/containers/_row.py
sort_columns(comparator=lambda , : col1[0] > col2[0] - col1[0] < col2[0])
¶
Sort the columns of a Row
with the given comparator and return a new Row
.
The original row is not modified. The comparator is a function that takes two tuples of (ColumnName,
Value) col1
and col2
and returns an integer:
- If
col1
should be ordered beforecol2
, the function should return a negative number. - If
col1
should be ordered aftercol2
, the function should return a positive number. - If the original order of
col1
andcol2
should be kept, the function should return 0.
If no comparator is given, the columns will be sorted alphabetically by their name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
comparator |
Callable[[tuple, tuple], int]
|
The function used to compare two tuples of (ColumnName, Value). |
lambda , : col1[0] > col2[0] - col1[0] < col2[0]
|
Returns:
Name | Type | Description |
---|---|---|
new_row |
Row
|
A new row with sorted columns. |
Source code in src/safeds/data/tabular/containers/_row.py
to_dict()
¶
Return a dictionary that maps column names to column values.
Returns:
Name | Type | Description |
---|---|---|
data |
dict[str, Any]
|
Dictionary representation of the row. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1, "b": 2})
>>> row.to_dict()
{'a': 1, 'b': 2}
Source code in src/safeds/data/tabular/containers/_row.py
to_html()
¶
Return an HTML representation of the row.
Returns:
Name | Type | Description |
---|---|---|
output |
str
|
The generated HTML. |
Examples:
>>> from safeds.data.tabular.containers import Row
>>> row = Row({"a": 1, "b": 2})
>>> html = row.to_html()