from guidance import guidance #759
Conversation
This reverts commit 9546946.
| @@ -26,10 +26,6 @@ no_implicit_optional = false # TODO: PEP484, set to true | |||
| strict = false # TODO: set to true | |||
| exclude = ["tests"] | |||
|
|
|||
| [[tool.mypy.overrides]] | |||
There was a problem hiding this comment.
This is the most relevant line, the one we are trying to delete to make mypy more comprehensive.
| @@ -1,4 +1,4 @@ | |||
| import guidance | |||
There was a problem hiding this comment.
Switching to relative imports
| @@ -0,0 +1,78 @@ | |||
| import functools | |||
There was a problem hiding this comment.
This is the new file, but almost all this code is copy-paste from init.py
|
|
||
| newline = "\n" | ||
|
|
||
| def guidance(f=None, *, stateless=False, cache=None, dedent=True, model=models.Model): |
There was a problem hiding this comment.
Here is the new guidance function
| @@ -863,7 +863,7 @@ def bos_token() -> ModelVariable: | |||
| # if len(low_bytes) > 1 or len(high_bytes) > 1: | |||
| # raise Exception("We don't yet support multi-byte character ranges!") | |||
| # return ByteRange(low_bytes + high_bytes) | |||
| def str_to_grammar(value: str) -> Union[str, bytes, Null, Byte, Join, Function]: | |||
| def str_to_grammar(value: str): | |||
There was a problem hiding this comment.
This was wrong in the last PR. I have no idea what the types for this function should be.
There was a problem hiding this comment.
Figuring that out has been on my ToDo list for a while. Similarly, I suspect that a few of the arguments to various functions only reflect a subset of the actual accepted types.
| # This makes the guidance module callable | ||
| class Guidance(types.ModuleType): | ||
| class _Guidance(types.ModuleType): |
There was a problem hiding this comment.
Made this private so people don't from guidance import Guidance
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## main #759 +/- ##
==========================================
- Coverage 69.53% 65.60% -3.94%
==========================================
Files 54 55 +1
Lines 4038 4044 +6
==========================================
- Hits 2808 2653 -155
- Misses 1230 1391 +161 ☔ View full report in Codecov by Sentry. |
|
Super cool that you were able to make this backwards compatible. I find the relative imports a bit more cumbersome -- it's always a pain remembering how many layers into the hierarchy you are... -- but I think the issue this solves around circular dependencies is worth the trouble. Curious what @riedgar-ms and @slundberg think but from my POV, this LGTM |
| @@ -863,7 +863,7 @@ def bos_token() -> ModelVariable: | |||
| # if len(low_bytes) > 1 or len(high_bytes) > 1: | |||
| # raise Exception("We don't yet support multi-byte character ranges!") | |||
| # return ByteRange(low_bytes + high_bytes) | |||
| def str_to_grammar(value: str) -> Union[str, bytes, Null, Byte, Join, Function]: | |||
| def str_to_grammar(value: str): | |||
There was a problem hiding this comment.
Figuring that out has been on my ToDo list for a while. Similarly, I suspect that a few of the arguments to various functions only reflect a subset of the actual accepted types.
This is a backwards compatible implementation of
from guidance import guidancethat fixes the need for ignoring operator errors in mypy (which handle + - typing but also apparently can not call module errors) due to "can not call module" errors in static typing.I do this by moving a lot of the code in
__init__.pyto a new_guidance.pyand creating a duplicate object toGuidancefrom__init__.pycalledguidancein_guidance.py, which can then be relatively imported from within the package.Outside the package, you can use either one. This also prevents some circular dependency errors from within the code that emerge when you import your own
__init__.py.