Core classes and methods#
Entity
#
Bases: BaseModel
The base class of all ontology classes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
IRI |
required |
Source code in pydontology/pydontology.py
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 | |
JSONLDGraph
#
Bases: BaseModel
Encapsulates a JSON-LD document/graph.
This is the return type of the make_model() function, and ontology_graph(), shacl_graph() class methods.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
context
|
dict
|
JSON-LD context (mapped to @context) |
required |
graph
|
List
|
Default graph containing entities (mapped to @graph) |
required |
Source code in pydontology/pydontology.py
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 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 | |
ontology_graph()
classmethod
#
Generate an ontology graph from the classes in the ontology.
Returns:
| Name | Type | Description |
|---|---|---|
JSONLDGraph |
JSONLDGraph
|
With _OntologyClass and _OntologyProperty (internal classes) instances. |
Source code in pydontology/pydontology.py
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 | |
shacl_graph()
classmethod
#
Generate SHACL shapes graph from the classes in the ontology.
Returns:
| Name | Type | Description |
|---|---|---|
JSONLDGraph |
JSONLDGraph
|
With _NodeShape and _PropertyShape (internal classes) instances. |
Source code in pydontology/pydontology.py
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 | |
Relation
#
Bases: BaseModel
This class should be the type of Entity attributes for them to be considered as IRIs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id
|
str
|
IRI of relation |
required |
Source code in pydontology/pydontology.py
11 12 13 14 15 16 17 18 19 | |
make_model(ontology, name='Pydontology')
#
Create a JSONLDGraph Pydantic model class
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
ontology
|
Union
|
Entity type or union of Entity types for the ontology. |
required |
name
|
str
|
Name for the generated model class. |
'Pydontology'
|
Returns:
| Type | Description |
|---|---|
type[JSONLDGraph]
|
type[JSONLDGraph]: A Pydantic model class with the specified ontology. |
Example::
from pydontology import Entity, make_model
class Person(Entity):
name: str
class Employee(Person):
title: str
ontology = Person | Employee
Model = make_model(ontology)
Source code in pydontology/pydontology.py
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 | |
Annotation classes#
These classes enable use of typing.Annotated to provide RDFS and SHACL metadata to attributes of the ontology classes, which is then used in the construction of the ontology graph and SHACL graph.
Not all RDFS or SHACL directives are supported currently. Contributions are welcome!
RDFSAnnotation
#
Provides methods for setting RDFS annotations.
Encapsulates dataclasses that validate and provide type information for RDFS annotations. These annotations are used in the construction of the ontology graph.
Source code in pydontology/rdfs.py
9 10 11 12 13 14 15 16 17 18 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 | |
DOMAIN
#
Dataclass that holds rdfs:domain annotation for a property.
rdfs:domain is an instance of rdf:Property that is used to state that any resource that has a given property is an instance of one or more classes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
Name of RDFS class |
required |
Source code in pydontology/rdfs.py
16 17 18 19 20 21 22 23 24 25 26 27 | |
RANGE
#
Dataclass that holds rdfs:range annotation for a property.
rdfs:range is an instance of rdf:Property that is used to state that the values of a property are instances of one or more classes.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
Name of RDFS class |
required |
Source code in pydontology/rdfs.py
29 30 31 32 33 34 35 36 37 38 39 40 | |
domain(value)
staticmethod
#
RDFSAnnotation.DOMAIN factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
Name of RDFS class |
required |
Returns:
| Type | Description |
|---|---|
DOMAIN
|
RDFSAnnotation.DOMAIN |
Source code in pydontology/rdfs.py
42 43 44 45 46 47 48 49 50 51 52 | |
range(value)
staticmethod
#
RDFSAnnotation.RANGE factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
Name of RDFS class |
required |
Returns:
| Type | Description |
|---|---|
RANGE
|
RDFSAnnotation.RANGE |
Source code in pydontology/rdfs.py
54 55 56 57 58 59 60 61 62 63 64 | |
SHACLAnnotation
#
Provides methods for setting SHACL annotations.
Encapsulates dataclasses that validate and provide type information for SHACL annotations. These annotations are used in the construction of the SHACL graph.
Source code in pydontology/shacl.py
15 16 17 18 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 | |
CLASS
#
Dataclass that holds sh:class annotation for a property.
Value type constraint. The type of all value nodes. The values of sh:class in a shape are IRIs.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
IRI of class |
required |
Source code in pydontology/shacl.py
174 175 176 177 178 179 180 181 182 183 184 185 | |
DATATYPE
#
Dataclass that holds sh:datatype annotation for a property.
The values of sh:datatype in a shape are IRIs (e.g. xsd:integer). A shape has at most one value for sh:datatype.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
IRI of datatype |
required |
Source code in pydontology/shacl.py
22 23 24 25 26 27 28 29 30 31 32 33 | |
MAX_COUNT
#
Dataclass that holds sh:maxCount annotation for a property.
The maximum cardinality. The values of sh:maxCount in a property shape are literals with datatype xsd:integer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Max cardinality of property |
required |
Source code in pydontology/shacl.py
35 36 37 38 39 40 41 42 43 44 45 46 | |
MAX_EXCLUSIVE
#
Dataclass that holds sh:maxExclusive annotation for a property.
Value range constraint. The maximum exclusive value. The values of sh:maxExclusive in a shape are literals. A shape has at most one value for sh:maxExclusive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Max exclusive value of RDF literal |
required |
Source code in pydontology/shacl.py
145 146 147 148 149 150 151 152 153 154 155 156 157 | |
MAX_INCLUSIVE
#
Dataclass that holds sh:maxInclusive annotation for a property.
Value range constraint. The maximum inclusive value. The values of sh:maxInclusive in a shape are literals. A shape has at most one value for sh:maxInclusive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Max inclusive value of RDF literal |
required |
Source code in pydontology/shacl.py
117 118 119 120 121 122 123 124 125 126 127 128 129 | |
MAX_LENGTH
#
Dataclass that holds sh:maxLength annotation for a property.
String-based constraint. The maximum length. The values of sh:maxLength in a shape are literals with datatype xsd:integer. A shape has at most one value for sh:maxLength.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Max length of RDF literal |
required |
Source code in pydontology/shacl.py
89 90 91 92 93 94 95 96 97 98 99 100 101 | |
MIN_COUNT
#
Dataclass that holds sh:minCount annotation for a property.
The minimum cardinality. The values of sh:minCount in a property shape are literals with datatype xsd:integer.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Min cardinality of property |
required |
Source code in pydontology/shacl.py
48 49 50 51 52 53 54 55 56 57 58 59 | |
MIN_EXCLUSIVE
#
Dataclass that holds sh:minExclusive annotation for a property.
Value range constraint. The minimum exclusive value. The values of sh:minExclusive in a shape are literals. A shape has at most one value for sh:minExclusive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Min exclusive value of RDF literal |
required |
Source code in pydontology/shacl.py
131 132 133 134 135 136 137 138 139 140 141 142 143 | |
MIN_INCLUSIVE
#
Dataclass that holds sh:minInclusive annotation for a property.
Value range constraint. The minimum inclusive value. The values of sh:minInclusive in a shape are literals. A shape has at most one value for sh:minInclusive.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Min inclusive value of RDF literal |
required |
Source code in pydontology/shacl.py
103 104 105 106 107 108 109 110 111 112 113 114 115 | |
MIN_LENGTH
#
Dataclass that holds sh:minLength annotation for a property.
String-based constraint. The minimum length. The values of sh:minLength in a shape are literals with datatype xsd:integer. A shape has at most one value for sh:minLength.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Min length of RDF literal |
required |
Source code in pydontology/shacl.py
75 76 77 78 79 80 81 82 83 84 85 86 87 | |
NODE_KIND
#
Dataclass that holds sh:nodeKind annotation for a property.
Value type constraint. The values of sh:nodeKind in a shape are one of the following six instances of the class sh:NodeKind: sh:BlankNode, sh:IRI, sh:Literal sh:BlankNodeOrIRI, sh:BlankNodeOrLiteral and sh:IRIOrLiteral. A shape has at most one value for sh:nodeKind.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
Instance of node kind |
required |
Source code in pydontology/shacl.py
159 160 161 162 163 164 165 166 167 168 169 170 171 172 | |
PATTERN
#
Dataclass that holds sh:pattern annotation for a property.
String-based constraint. A regular expression that all value nodes need to match. The values of sh:pattern in a shape are valid pattern arguments for the SPARQL REGEX function.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
SPARQL regex (validation not implemented!) |
required |
Source code in pydontology/shacl.py
61 62 63 64 65 66 67 68 69 70 71 72 73 | |
datatype(value)
staticmethod
#
SHACLAnnotation.DATATYPE factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
IRI of datatype |
required |
Returns:
| Type | Description |
|---|---|
DATATYPE
|
SHACLAnnotation.DATATYPE |
Source code in pydontology/shacl.py
187 188 189 190 191 192 193 194 195 196 197 | |
maxCount(value)
staticmethod
#
SHACLAnnotation.MAX_COUNT factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Max cardinality of property |
required |
Returns:
| Type | Description |
|---|---|
MAX_COUNT
|
SHACLAnnotation.MAX_COUNT |
Source code in pydontology/shacl.py
199 200 201 202 203 204 205 206 207 208 209 | |
maxExclusive(value)
staticmethod
#
SHACLAnnotation.MAX_EXCLUSIVE factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Max exclusive value of RDF literal |
required |
Returns:
| Type | Description |
|---|---|
MAX_EXCLUSIVE
|
SHACLAnnotation.MAX_EXCLUSIVE |
Source code in pydontology/shacl.py
295 296 297 298 299 300 301 302 303 304 305 | |
maxInclusive(value)
staticmethod
#
SHACLAnnotation.MAX_INCLUSIVE factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Max inclusive value of RDF literal |
required |
Returns:
| Type | Description |
|---|---|
MAX_INCLUSIVE
|
SHACLAnnotation.MAX_INCLUSIVE |
Source code in pydontology/shacl.py
271 272 273 274 275 276 277 278 279 280 281 | |
maxLength(value)
staticmethod
#
SHACLAnnotation.MAX_LENGTH factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Max length of RDF literal |
required |
Returns:
| Type | Description |
|---|---|
MAX_LENGTH
|
SHACLAnnotation.MAX_LENGTH |
Source code in pydontology/shacl.py
247 248 249 250 251 252 253 254 255 256 257 | |
minCount(value)
staticmethod
#
SHACLAnnotation.MIN_COUNT factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Min cardinality of property |
required |
Returns:
| Type | Description |
|---|---|
MIN_COUNT
|
SHACLAnnotation.MIN_COUNT |
Source code in pydontology/shacl.py
211 212 213 214 215 216 217 218 219 220 221 | |
minExclusive(value)
staticmethod
#
SHACLAnnotation.MIN_EXCLUSIVE factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Min exclusive value of RDF literal |
required |
Returns:
| Type | Description |
|---|---|
MIN_EXCLUSIVE
|
SHACLAnnotation.MIN_EXCLUSIVE |
Source code in pydontology/shacl.py
283 284 285 286 287 288 289 290 291 292 293 | |
minInclusive(value)
staticmethod
#
SHACLAnnotation.MIN_INCLUSIVE factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int | float
|
Min inclusive value of RDF literal |
required |
Returns:
| Type | Description |
|---|---|
MIN_INCLUSIVE
|
SHACLAnnotation.MIN_INCLUSIVE |
Source code in pydontology/shacl.py
259 260 261 262 263 264 265 266 267 268 269 | |
minLength(value)
staticmethod
#
SHACLAnnotation.MIN_LENGTH factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
int
|
Min length of RDF literal |
required |
Returns:
| Type | Description |
|---|---|
MIN_LENGTH
|
SHACLAnnotation.MIN_LENGTH |
Source code in pydontology/shacl.py
235 236 237 238 239 240 241 242 243 244 245 | |
nodeKind(value)
staticmethod
#
SHACLAnnotation.NODE_KIND factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
Instance of node kind |
required |
Returns:
| Type | Description |
|---|---|
NODE_KIND
|
SHACLAnnotation.NODE_KIND |
Source code in pydontology/shacl.py
307 308 309 310 311 312 313 314 315 316 317 | |
pattern(value)
staticmethod
#
SHACLAnnotation.PATTERN factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
SPARQL regex (validation not implemented!) |
required |
Returns:
| Type | Description |
|---|---|
PATTERN
|
SHACLAnnotation.PATTERN |
Source code in pydontology/shacl.py
223 224 225 226 227 228 229 230 231 232 233 | |
shclass(value)
staticmethod
#
SHACLAnnotation.CLASS factory
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
value
|
str
|
IRI of class |
required |
Returns:
| Type | Description |
|---|---|
CLASS
|
SHACLAnnotation.CLASS |
Source code in pydontology/shacl.py
319 320 321 322 323 324 325 326 327 328 329 | |