V0.15.0 #185

brandon-wada · 2024-03-15T21:43:36Z

Combines some other PRs and allows:

Full creation, deletion, and fetching of actions
The ability to download images given their image query, solving issue Feature request: Given an image query ID I would like to be able to download the image from groundlight. #75
The ability to get notes and add notes to a detector

Further SDK development should NOT follow this pattern. Bouncing back and forth between the two repos is clunky to test, but more importantly we probably want to move away from manually writing out the spec.

…t notifications

auto-generated time is wrong, but I'll update the autogenerated code in a bit

… with dev environment and make the sdk code cleaner and nicer

…cumented yet as they may be unstable

…nto feature_whoami2

…on-sdk into expanding_notifications

…nterested in

mjvogelsong

Looks good!

The main thing is that I don't think we should change the supported python versions to 3.10+ in this PR (it will break our github action test-comprehensive test matrix for 3.7-3.9)

mjvogelsong · 2024-03-19T16:20:32Z

pyproject.toml

 requests = "^2.28.2"
 urllib3 = "^1.26.9"
 typer = "^0.9.0"
+ipython = "^8.22.2"


We're trying to keep the package size small, so we probably don't want to include ipython. Or at least, we should move it to dev dependencies.

thanks for catching that, this wasn't supposed to make it in. I wanted IPython for a bit of debugging at one point. I like the idea of adding it to dev dependencies.

mjvogelsong · 2024-03-19T16:22:17Z

pyproject.toml

 pillow = ">=9.0.0" # TODO: We may want to mark pillow (and numpy) as extra (https://python-poetry.org/docs/master/pyproject#extras)
 pydantic = ">=1.7.4,<3.0.0"
-python = ">=3.7.0,<4.0"
+python = ">=3.10.0,<4.0"


I think we still are supporting older versions of python. Was there a dependency change that caused this update?

I don't think we should be supporting 3.7 anymore because it is past "end-of-life" (please ask avi/leo what they think), but I do think some people still use 3.8. If we bump to 3.8+, then we could remove the 3.7 part of the github action test matrix.

https://devguide.python.org/versions/

Suggested change

python = ">=3.10.0,<4.0"

python = ">=3.8,<4.0"

mjvogelsong · 2024-03-19T19:31:29Z

src/groundlight/experimentalapi.py

+        obj = self.rules_api.list_rules(page=page, page_size=page_size)
+        return PaginatedRuleList.parse_obj(obj.to_dict())
+
+    def delete_all_rules(self, detector: Union[None, str, Detector] = None) -> None:


In the future, we may want a bulk delete endpoint.

I think we have a request sitting around for bulk iq retrieval as well. As time permits, I'll look at adding that endpoint

mjvogelsong · 2024-03-19T19:32:39Z

src/groundlight/experimentalapi.py

+        for page in range(1, (num_rules // 10) + 2):
+            for rule in self.list_rules(page=page, page_size=10).results:


I think we could use a larger page size, like 100. And I would put it in a common variable, so we don't accidentally introduce a bug.

mjvogelsong · 2024-03-19T19:33:28Z

src/groundlight/experimentalapi.py

+        obj = self.rules_api.list_rules(page=page, page_size=page_size)
+        return PaginatedRuleList.parse_obj(obj.to_dict())
+
+    def delete_all_rules(self, detector: Union[None, str, Detector] = None) -> None:


We could return the number of deleted rules, if that's useful.

mjvogelsong · 2024-03-19T19:34:24Z

test/unit/test_actions.py

+    return ExperimentalApi()
+
+
+def test_create_action(gl: ExperimentalApi):


Suggested change

def test_create_action(gl: ExperimentalApi):

def test_create_rule(gl: ExperimentalApi):

…th zuuul endpoint

brandon-wada · 2024-03-28T16:57:40Z

Sorry for the extra emails, the github runner was behaving differently than my local machine and took a sec to debug. But this is ready now!

mjvogelsong · 2024-03-28T18:04:01Z

src/groundlight/experimental_api.py

@@ -0,0 +1,173 @@
+"""
+experimental_t api.py


Suggested change

experimental_t api.py

experimental_api.py

mjvogelsong · 2024-03-28T18:06:13Z

src/groundlight/experimental_api.py

+        snooze_time_unit: str = "SECONDS",
+    ) -> Rule:
+        """
+        Adds a notification action to the given detector


Suggested change

Adds a notification action to the given detector

Adds a notification rule to the given detector

mjvogelsong · 2024-03-28T18:08:30Z

test/unit/test_notes.py

+@pytest.fixture(name="gl")
+def _gl() -> ExperimentalApi:
+    return ExperimentalApi()


We can pull this into a common module.

mjvogelsong · 2024-03-28T18:09:47Z

test/unit/test_actions.py

+
+
+def test_get_all_actions(gl: ExperimentalApi):
+    num_test_rules = 103  # needs to be larger than the default page size


I don't think we should be creating this many rules in unit tests -- instead, we should patch the default page size to something smaller.

mjvogelsong · 2024-03-28T18:26:49Z

test/unit/test_notes.py

+    try:
+        notes = gl.get_notes(det)["gl"]
+        found_note = False
+        for i in range(len(notes)):
+            if notes[i].content == "test_note":
+                found_note = True
+        assert found_note
+    except (AssertionError, ApiAttributeError):
+        notes = gl.get_notes(det)["customer"]
+        found_note = False
+        for i in range(len(notes)):
+            if notes[i].content == "test_note":
+                found_note = True
+        assert found_note


Does something like this work?

Suggested change

try:

notes = gl.get_notes(det)["gl"]

found_note = False

for i in range(len(notes)):

if notes[i].content == "test_note":

found_note = True

assert found_note

except (AssertionError, ApiAttributeError):

notes = gl.get_notes(det)["customer"]

found_note = False

for i in range(len(notes)):

if notes[i].content == "test_note":

found_note = True

assert found_note

notes = (gl.get_notes(det).get("gl") or []) + (gl.get_notes(det).get("customer") or [])

found_note = False

for i in range(len(notes)):

if notes[i].content == "test_note":

found_note = True

assert found_note

ooh, that's nice

brandon and others added 30 commits February 27, 2024 14:55

wip. mix of whoami improvments and change to the public-api to suppor…

50886fc

…t notifications

Merge branch 'main' into feature_whoami2

5134485

auto-generated time is wrong, but I'll update the autogenerated code in a bit

Experimenting with autogenerating the request function

e3857b8

Some debugging, but it seems like a valid request is sent. TODO, test…

8899c19

… with dev environment and make the sdk code cleaner and nicer

Automatically reformatting code

a505c9c

Seems to work. The parameters for each type of notification aren't do…

77bc961

…cumented yet as they may be unstable

Making very clear that this isn't in the final release of the SDK

f0b9e58

Merge branch 'feature_whoami2' of github.com:groundlight/python-sdk i…

a38a7be

…nto feature_whoami2

Automatically reformatting code

60343f9

make the UnstableApi class accessible like the Groundlight class

3b162ec

Merge branch 'feature_whoami2' of github.com:groundlight/python-sdk i…

0d21193

…nto feature_whoami2

this is pretty much the spec, need to switch gears rn tho

ca39d72

rename to experimentalApi

7c22e43

adds get and delete methods

058be12

add get rule list and delete all rules. And added tests

9bb9015

Automatically reformatting code

e211eaf

regenerating code to remove old files and correct a type

451abbb

Merge branch 'expanding_notifications' of github.com:groundlight/pyth…

3304250

…on-sdk into expanding_notifications

linting mostly

b996c55

Automatically reformatting code

e04ec80

addressing comments before next big PR

8334d3d

typo

00c47b6

removing old file

1e61ba9

lint

3519c1d

esoteric linter stuff

4c41277

pylint is acting weird still

705430c

Merge branch 'main' into feature_whoami2

9f1dedd

Ok, there was one legit linter error among several that I'm not too i…

3149a61

…nterested in

aaa

2a1644f

Merge branch 'feature_whoami2' into expanding_notifications

4accc12

brandon-wada requested review from blaise-muhirwa, mjvogelsong, robotrapta and roxanne-o March 15, 2024 22:00

brandon and others added 6 commits March 18, 2024 00:20

Updates the endpoint for images

b3c75e1

Automatically reformatting code

03fd098

fix how client handles rules

71eb464

Automatically reformatting code

6c6763a

change testing endpoint

996e7ab

Merge branch 'v0.15.0' of github.com:groundlight/python-sdk into v0.15.0

9338c16

mjvogelsong reviewed Mar 19, 2024

View reviewed changes

brandon and others added 7 commits March 25, 2024 18:23

Incorporated suggestions, regenerated files. Ran into one last bug wi…

50560d3

…th zuuul endpoint

Merge branch 'main' into v0.15.0

f5b6d77

regenerate api code

baaee94

upgrading the datetime calls was supposed to be innocuous

b5d58cb

Automatically reformatting code

6782a2b

Trigger CI

add2f50

Correcting note type available in the sdk

9ac4b7d

brandon-wada force-pushed the v0.15.0 branch from ca8d4f1 to 0497d14 Compare March 27, 2024 23:11

customer types in test

0b1144b

brandon-wada force-pushed the v0.15.0 branch from 0497d14 to 0b1144b Compare March 27, 2024 23:20

Auto-format Bot and others added 4 commits March 27, 2024 23:21

Automatically reformatting code

23d09de

more fixes

ce56295

Merge branch 'v0.15.0' of github.com:groundlight/python-sdk into v0.15.0

813710a

case issue

d065fb3

mjvogelsong approved these changes Mar 28, 2024

View reviewed changes

good suggestions

ee1a2a8

brandon-wada merged commit 233f837 into main Mar 28, 2024

tyler-romero deleted the v0.15.0 branch April 1, 2024 18:51

		for page in range(1, (num_rules // 10) + 2):
		for rule in self.list_rules(page=page, page_size=10).results:

		return ExperimentalApi()


		def test_create_action(gl: ExperimentalApi):

	def test_create_action(gl: ExperimentalApi):
	def test_create_rule(gl: ExperimentalApi):

	Adds a notification action to the given detector
	Adds a notification rule to the given detector



		def test_get_all_actions(gl: ExperimentalApi):
		num_test_rules = 103 # needs to be larger than the default page size

V0.15.0 #185

V0.15.0 #185

Uh oh!

Conversation

brandon-wada commented Mar 15, 2024

Uh oh!

mjvogelsong left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brandon-wada commented Mar 28, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants