Create an Interface for programatically creating shapes

[TShapinsky]

Create initial base classes for shape builders.

Demo:
https://github.com/NREL/BuildingMOTIF/blob/shape_builder/notebooks/Shape_Builder.ipynb

TODO:

• add missing functionality
• create tests
• Demo easy manifest creation
• Add doc strings

closes #116

[gtfierro]

Looking really great! Couple small changes and fixes

[TShapinsky]

Once the API structure seems OK I'll move onto the additional steps

[codecov-commenter]

Codecov Report

Patch and project coverage have no change.

Comparison is base (25a234c) 73.40% compared to head (280ee59) 73.40%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop     #165   +/-   ##
========================================
  Coverage    73.40%   73.40%           
========================================
  Files           31       31           
  Lines         2012     2012           
========================================
  Hits          1477     1477           
  Misses         535      535           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[TShapinsky]

@gtfierro Do you have any idea how this PR caused these failures?

[gtfierro]

My guess is it is related to the version bumps on rdflib and pyshacl. I've pushed a couple commits which I hoped would solve the issues, but it looks like there's a couple outstanding ones. I should be able to continue work on it this weekend

[TShapinsky]

My guess is it is related to the version bumps on rdflib and pyshacl. I've pushed a couple commitments which I hoped would solve the issues, but it looks like there's a couple outstanding ones. I should be able to continue work on it this weekend

I thought the same thing too. The only thing that wigs me out is that it should be installing dependencies from the poetry.lock not resolving them. And I didn't update the lock

[gtfierro]

Regardless of why the deps changed, I think I've almost fixed all of the issues. The last bit I think is due to the prefix declarations for SHACL rules not being handled correctly in the earlier version of Brick that is currently committed to the repo. This is fixed in a more recent version of Brick, but updating to the recent version would also require handling imports correctly in BuildingMOTIF. I've pushed a "quickfix" but eventually we should update Brick and handle ontology imports

[gtfierro]

@haneslinger it looks like the last failing test has to do with the Flask API server in tests/unit/api/test_library.py:73

2023-05-05T17:54:13.1421712Z         # Act
2023-05-05T17:54:13.1421949Z         results = client.get("/libraries/shapes")
2023-05-05T17:54:13.1422170Z     
2023-05-05T17:54:13.1422329Z         # Assert
2023-05-05T17:54:13.1422546Z >       assert results.status_code == 200
2023-05-05T17:54:13.1422770Z E       assert 500 == 200
2023-05-05T17:54:13.1423066Z E        +  where 500 = <WrapperTestResponse streamed [500 INTERNAL SERVER ERROR]>.status_code

I can't find anything in the logs that suggests what is going wrong. Any ideas? Otherwise I can start adding some logging statements. Can't get it to reproduce locally

[TShapinsky]

@haneslinger it looks like the last failing test has to do with the Flask API server in tests/unit/api/test_library.py:73

2023-05-05T17:54:13.1421712Z         # Act
2023-05-05T17:54:13.1421949Z         results = client.get("/libraries/shapes")
2023-05-05T17:54:13.1422170Z     
2023-05-05T17:54:13.1422329Z         # Assert
2023-05-05T17:54:13.1422546Z >       assert results.status_code == 200
2023-05-05T17:54:13.1422770Z E       assert 500 == 200
2023-05-05T17:54:13.1423066Z E        +  where 500 = <WrapperTestResponse streamed [500 INTERNAL SERVER ERROR]>.status_code

I can't find anything in the logs that suggests what is going wrong. Any ideas? Otherwise I can start adding some logging statements. Can't get it to reproduce locally

I don't have any ideas about that, I'm digging into some stuff locally

[TShapinsky]

@gtfierro I was able to reproduce by doing poetry install --all-extras since that's what the ci does

[TShapinsky]

It is an "Unknown namespace prefix : sh" error when it attempts to run the shape query. Any ideas? @gtfierro

[gtfierro]

It is an "Unknown namespace prefix : sh" error when it attempts to run the shape query. Any ideas? @gtfierro

Have you pulled latest from this branch? I think I've fixed that so its just the Flask error

[TShapinsky]

It is an "Unknown namespace prefix : sh" error when it attempts to run the shape query. Any ideas? @gtfierro

Have you pulled latest from this branch? I think I've fixed that so its just the Flask error

Yeah, that is the flask error I believe, if you just print the response text in the test that is the string you get with the 500 error.

[gtfierro]

Were you able to reproduce the Flask error locally? I'm not able to even with installing with --all-extras. Or are you getting the response text some other way? Doesn't seem to be in the error trace online

[gtfierro]

I think I might have found the bug! We were missing prefixes in the SPARQL query; later versions of RDFlib/pyshacl seem to care more about having prefixes declared rather than inferring them from other graphs

[gtfierro]

I'm good with these changes! Glad we figured out the tests at last