guidance-ai/guidance

Pattern Findings

542 matches across 14 categories. Click a row to expand file-level details.

Hyper-Verbose Identifiers217 hits · 214 pts

Severity	File	Line	Snippet
LOW	README.md	175	def zero_shot_multiple_choice(
LOW	guidance/_ast.py	217	def is_allowed_in_lark_terminal(self) -> bool:
LOW	guidance/_ast.py	225	def is_allowed_in_lark_rule_with_attrs(self) -> bool:
LOW	guidance/_ast.py	348	def is_allowed_in_lark_terminal(self) -> bool:
LOW	guidance/_ast.py	352	def is_allowed_in_lark_rule_with_attrs(self) -> bool:
LOW	guidance/_ast.py	450	def is_allowed_in_lark_terminal(self) -> bool:
LOW	guidance/_ast.py	489	def is_allowed_in_lark_terminal(self) -> bool:
LOW	guidance/_ast.py	519	def is_allowed_in_lark_terminal(self) -> bool:
LOW	guidance/_ast.py	533	def is_allowed_in_lark_terminal(self) -> bool:
LOW	guidance/_ast.py	537	def is_allowed_in_lark_rule_with_attrs(self) -> bool:
LOW	guidance/_uri_validation.py	66	def _validate_hostname_not_private(hostname: str, original_url: str) -> None:
LOW	guidance/chat.py	83	def _template_class_from_string(template_str):
LOW	guidance/_utils.py	128	def strip_multiline_string_indents(f):
LOW	guidance/_utils.py	423	def apply_top_k_and_top_p_filter(logits: np.ndarray, sampling_params: Optional["SamplingParams"]) -> np.ndarray:
LOW	guidance/models/_mock.py	94	def get_next_token_with_top_k(
LOW	guidance/models/_openai_base.py	217	def streaming_chat_completions(
LOW	guidance/models/_openai_base.py	232	def streaming_chat_completions(
LOW	guidance/models/_azureai.py	76	def create_azure_openai_model(
LOW	guidance/models/_azureai.py	162	def streaming_chat_completions(
LOW	guidance/models/_azureai.py	220	def create_azure_aifoundry_model(
LOW	guidance/models/_transformers.py	179	def _byte_tokens_from_byte_decoder(
LOW	guidance/models/_transformers.py	194	def _byte_tokens_from_sp_model(
LOW	guidance/models/_transformers.py	217	def _byte_tokens_by_encoding_token_strings(
LOW	guidance/models/_transformers.py	278	def check_byte_decoder_has_all_bytes() -> None:
LOW	guidance/models/_transformers.py	287	def check_byte_decoder_complex_round_trip() -> None:
LOW	guidance/models/experimental/_litellm.py	46	def streaming_chat_completions(
LOW	guidance/models/_engine/_engine.py	542	def get_next_token_with_top_k(
LOW	guidance/models/_engine/_engine.py	659	def chat_completion_streaming(
LOW	guidance/models/_engine/_engine.py	732	def apply_temp_and_sampling_params(
LOW	guidance/models/_base/_model.py	192	def _update_open_block_captures(self) -> Self:
LOW	guidance/_bg/__init__.py	20	def _asyncio_background_thread() -> tuple[threading.Thread, AbstractEventLoop]:
LOW	tests/tokenizer_common.py	37	def base_eos_bos_token_round_trip(self, model_name: str):
LOW	tests/utils.py	114	def check_match_success_with_guards(grammar, test_string: str):
LOW	tests/utils.py	194	def check_run_with_temperature(lm: models.Model, desired_temperature: float):
LOW	tests/unit/test_parser.py	17	def test_zero_or_more_and_one_or_more():
LOW	tests/unit/test_parser.py	34	def test_zero_or_more_and_one_or_more_mixed():
LOW	tests/unit/test_parser.py	117	def test_char_set_one_or_more():
LOW	tests/unit/test_model.py	58	def test_step_every_k_injection():
LOW	tests/unit/test_model.py	84	def test_step_stop_token_trigger_injection():
LOW	tests/unit/test_grammar.py	24	def test_select_ambiguous_lexeme_boundary():
LOW	tests/unit/test_grammar.py	33	def test_select_ambiguous_lexeme_boundary_manual_fix():
LOW	tests/unit/test_grammar.py	50	def test_grammar_plus_fstring():
LOW	tests/unit/test_grammar.py	82	def test_multiple_mutual_recursion(self):
LOW	tests/unit/test_grammar.py	99	def test_branching_mutual_recursion(self):
LOW	tests/unit/test_grammar.py	140	def test_raises_on_incomplete_input(self):
LOW	tests/unit/test_uri_validation.py	11	def test_https_allowed_by_default(self):
LOW	tests/unit/test_uri_validation.py	16	def test_http_blocked_by_default(self):
LOW	tests/unit/test_uri_validation.py	20	def test_ftp_blocked_by_default(self):
LOW	tests/unit/test_uri_validation.py	24	def test_http_allowed_when_configured(self):
LOW	tests/unit/test_uri_validation.py	28	def test_custom_scheme_allowed(self):
LOW	tests/unit/test_uri_validation.py	32	def test_scheme_check_is_case_insensitive(self):
LOW	tests/unit/test_uri_validation.py	38	def test_file_uri_blocked_when_allow_local_false(self):
LOW	tests/unit/test_uri_validation.py	42	def test_file_uri_allowed_when_allow_local_true(self):
LOW	tests/unit/test_uri_validation.py	46	def test_file_uri_not_subject_to_scheme_allowlist(self):
LOW	tests/unit/test_uri_validation.py	105	def test_ip_literal_in_url_blocked(self):
LOW	tests/unit/test_uri_validation.py	118	def test_dns_resolution_failure_raises(self):
LOW	tests/unit/test_uri_validation.py	129	def test_all_resolved_addresses_checked(self):
LOW	tests/unit/test_bytes_from.py	12	def test_blocks_http_by_default(self):
LOW	tests/unit/test_bytes_from.py	16	def test_allows_http_when_configured(self):
LOW	tests/unit/test_bytes_from.py	24	def test_blocks_private_ip_by_default(self):
157 more matches not shown…

Unused Imports119 hits · 114 pts

Severity	File	Line
LOW	guidance/_tools.py	11
LOW	guidance/__init__.py	8
LOW	guidance/__init__.py	11
LOW	guidance/_ast.py	31
LOW	guidance/_ast.py	31
LOW	guidance/_parser.py	13
LOW	guidance/_utils.py	21
LOW	guidance/metrics/__init__.py	3
LOW	guidance/metrics/__init__.py	3
LOW	guidance/metrics/__init__.py	3
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/trace/__init__.py	9
LOW	guidance/library/__init__.py	3
LOW	guidance/library/__init__.py	3
LOW	guidance/library/__init__.py	3
LOW	guidance/library/__init__.py	3
LOW	guidance/library/__init__.py	3
LOW	guidance/library/__init__.py	4
LOW	guidance/library/__init__.py	4
LOW	guidance/library/__init__.py	7
LOW	guidance/library/__init__.py	8
LOW	guidance/library/__init__.py	9
LOW	guidance/library/__init__.py	9
LOW	guidance/library/__init__.py	10
LOW	guidance/library/__init__.py	10
LOW	guidance/library/__init__.py	11
LOW	guidance/library/__init__.py	11
LOW	guidance/library/__init__.py	12
LOW	guidance/library/__init__.py	13
LOW	guidance/library/__init__.py	14
LOW	guidance/library/__init__.py	14
LOW	guidance/library/__init__.py	14
LOW	guidance/library/__init__.py	14
LOW	guidance/library/__init__.py	17
LOW	guidance/library/__init__.py	17
LOW	guidance/library/__init__.py	17
LOW	guidance/library/__init__.py	17
LOW	guidance/library/__init__.py	17
LOW	guidance/library/__init__.py	18
LOW	guidance/library/__init__.py	19
LOW	guidance/library/__init__.py	19
LOW	guidance/library/_subgrammar.py	2
59 more matches not shown…

Over-Commented Block94 hits · 93 pts

Severity	File	Line	Snippet
LOW	guidance/models/broken_models/_lite_llm.py	1	# import tiktoken
LOW	guidance/models/broken_models/_lite_llm.py	21	# "Please install the litellm package version >= 1.7 using `pip install litellm -U` in order to use guid
LOW	guidance/models/broken_models/_lite_llm.py	41	# )
LOW	guidance/models/broken_models/_lite_llm.py	61
LOW	guidance/models/broken_models/_lite_llm.py	81
LOW	guidance/models/broken_models/_lite_llm.py	101	# n=1,
LOW	guidance/models/broken_models/_lite_llm.py	121	# else:
LOW	guidance/models/broken_models/_lite_llm.py	141	# raise Exception(
LOW	guidance/models/broken_models/_lite_llm.py	161	# except Exception as e: # TODO: add retry logic
LOW	guidance/models/broken_models/_lite_llm.py	181	# messages = []
LOW	guidance/models/broken_models/_lite_llm.py	201	# pos += end_pos + len(role_end)
LOW	guidance/models/broken_models/_lite_llm.py	221	# except Exception as e: # TODO: add retry logic
LOW	guidance/models/broken_models/_cohere.py	1	# from ._lite_llm import LiteLLMEngine, LiteLLM, LiteLLMCompletion, LiteLLMInstruct
LOW	guidance/models/broken_models/_cohere.py	21
LOW	guidance/models/broken_models/_cohere.py	41	# class CohereCompletion(Cohere, LiteLLMCompletion):
LOW	guidance/models/broken_models/_azure_openai.py	1	# import pathlib
LOW	guidance/models/broken_models/_azure_openai.py	21	# """Represents an Azure OpenAI model as exposed through their remote API.
LOW	guidance/models/broken_models/_azure_openai.py	41	# max_streaming_tokens: int = 1000,
LOW	guidance/models/broken_models/_azure_openai.py	61	# if not is_openai or not hasattr(openai_package, "OpenAI"):
LOW	guidance/models/broken_models/_azure_openai.py	81
LOW	guidance/models/broken_models/_azure_openai.py	101	# engine_instance,
LOW	guidance/models/broken_models/_googleai.py	1	# import re
LOW	guidance/models/broken_models/_googleai.py	21	# model,
LOW	guidance/models/broken_models/_googleai.py	41	# genai.configure(api_key=api_key)
LOW	guidance/models/broken_models/_googleai.py	61	# timeout=0.5,
LOW	guidance/models/broken_models/_googleai.py	81
LOW	guidance/models/broken_models/_googleai.py	101	# engine=engine_map[self.__class__](
LOW	guidance/models/broken_models/_googleai.py	121	# assistant_start = b"<\|im_start\|>assistant\n"
LOW	guidance/models/broken_models/_googleai.py	141	# end_pos = prompt[pos:].find(role_end)
LOW	guidance/models/broken_models/_googleai.py	161	# )
LOW	guidance/models/broken_models/_googleai.py	181
LOW	guidance/models/broken_models/_googleai.py	201	# formated_messages = []
LOW	guidance/models/broken_models/_googleai.py	221	# formated_messages.append(Content(role=m["role"], parts=parts))
LOW	guidance/models/broken_models/_googleai.py	241	# class GoogleAIChat(GoogleAI, Chat):
LOW	guidance/models/broken_models/_Gemini.py	1	# import os
LOW	guidance/models/broken_models/_Gemini.py	21
LOW	guidance/models/broken_models/_Gemini.py	41	# is_vertexai = True
LOW	guidance/models/broken_models/_Gemini.py	61	# # caching=caching,
LOW	guidance/models/broken_models/_Gemini.py	81	# # tokenizer=tokenizer,
LOW	guidance/models/broken_models/_Gemini.py	101	# # the superclass does all the work
LOW	guidance/models/broken_models/_Gemini.py	121	# # last_user_text = messages[-1]["content"]
LOW	guidance/models/broken_models/_Gemini.py	141
LOW	guidance/models/broken_models/_anthropic.py	1	# import os
LOW	guidance/models/broken_models/_anthropic.py	21	# except ModuleNotFoundError:
LOW	guidance/models/broken_models/_anthropic.py	41	# except:
LOW	guidance/models/broken_models/_anthropic.py	61	# ("assistant", b"<\|im_start\|>assistant\n"),
LOW	guidance/models/broken_models/_anthropic.py	81
LOW	guidance/models/broken_models/_anthropic.py	101	# temperature=temperature,
LOW	guidance/models/broken_models/_anthropic.py	121	# there are some things we cannot do, like force the model to follow a pattern inside
LOW	guidance/models/broken_models/_anthropic.py	141	# tokenizer=tokenizer,
LOW	guidance/models/broken_models/_azureai_studio.py	1	# import hashlib
LOW	guidance/models/broken_models/_azureai_studio.py	21	# class AzureAIStudioChatEngine(GrammarlessEngine):
LOW	guidance/models/broken_models/_azureai_studio.py	41	# "Detected OpenAI compatible model; please install openai package"
LOW	guidance/models/broken_models/_azureai_studio.py	61
LOW	guidance/models/broken_models/_azureai_studio.py	81	# found = True
LOW	guidance/models/broken_models/_azureai_studio.py	101	# message_content = btext.decode("utf8")
LOW	guidance/models/broken_models/_azureai_studio.py	121	# cache_key = self._hash_prompt(prompt)
LOW	guidance/models/broken_models/_azureai_studio.py	141
LOW	guidance/models/broken_models/_azureai_studio.py	161	# response_score = requests.post(
LOW	guidance/models/broken_models/_azureai_studio.py	181	# yield encoded_chunk
34 more matches not shown…

Decorative Section Separators22 hits · 69 pts

Severity	File	Line	Snippet
MEDIUM	guidance/chat.py	91	# --------------------------------------------------
MEDIUM	guidance/chat.py	93	# --------------------------------------------------
MEDIUM	guidance/chat.py	111	# --------------------------------------------------
MEDIUM	guidance/chat.py	113	# --------------------------------------------------
MEDIUM	guidance/chat.py	146	# --------------------------------------------------
MEDIUM	guidance/chat.py	148	# --------------------------------------------------
MEDIUM	guidance/chat.py	173	# --------------------------------------------------
MEDIUM	guidance/chat.py	175	# --------------------------------------------------
MEDIUM	guidance/chat.py	230	# --------------------------------------------------
MEDIUM	guidance/chat.py	232	# --------------------------------------------------
MEDIUM	guidance/chat.py	251	# --------------------------------------------------
MEDIUM	guidance/chat.py	253	# --------------------------------------------------
MEDIUM	guidance/chat.py	285	# --------------------------------------------------
MEDIUM	guidance/chat.py	287	# --------------------------------------------------
MEDIUM	guidance/chat.py	317	# --------------------------------------------------
MEDIUM	guidance/chat.py	319	# --------------------------------------------------
MEDIUM	guidance/chat.py	345	# --------------------------------------------------
MEDIUM	guidance/chat.py	347	# --------------------------------------------------
MEDIUM	guidance/chat.py	371	# --------------------------------------------------
MEDIUM	guidance/chat.py	373	# --------------------------------------------------
MEDIUM	guidance/models/broken_models/_azure_openai.py	49	# ----------
MEDIUM	guidance/models/broken_models/_azureai_studio.py	214	# ----------

Cross-File Repetition9 hits · 45 pts

Severity	File	Snippet
HIGH	guidance/models/_llama_cpp.py	computes the logits for the given token state. this overrides a method from the localengine class that is used to get in
HIGH	guidance/models/_transformers.py	computes the logits for the given token state. this overrides a method from the localengine class that is used to get in
HIGH	guidance/models/_onnxruntime.py	computes the logits for the given token state. this overrides a method from the localengine class that is used to get in
HIGH	guidance/visual/_renderer.py	initializes. args: trace_handler: trace handler of an engine.
HIGH	guidance/visual/_renderer.py	initializes. args: trace_handler: trace handler of an engine.
HIGH	guidance/visual/_renderer.py	initializes. args: trace_handler: trace handler of an engine.
HIGH	tests/model_specific/test_onnxruntime_genai.py	tweak this proverb to apply to model instructions instead. {gen("verse", max_tokens=2)}
HIGH	tests/model_specific/test_transformers.py	tweak this proverb to apply to model instructions instead. {gen("verse", max_tokens=2)}
HIGH	tests/model_specific/llama_cpp_tests/test_llama_cpp.py	tweak this proverb to apply to model instructions instead. {gen("verse", max_tokens=2)}

Self-Referential Comments10 hits · 34 pts

Severity	File	Line	Snippet
MEDIUM	guidance/models/_openai_base.py	484	# Create an in-memory WAV file
MEDIUM	guidance/models/_transformers.py	405	# Create the tokenizer
MEDIUM	guidance/models/_base/_model.py	368	# Define the target function for the thread
MEDIUM	tests/unit/test_decorator.py	407	# Create a weak reference to the object
MEDIUM	tests/unit/test_decorator.py	420	# Create a weak reference to the object
MEDIUM	tests/unit/test_decorator.py	433	# Create a weak reference to the object
MEDIUM	tests/unit/test_decorator.py	435	# Create a weak reference to the cached method
MEDIUM	docs/conf.py	7	# This file is execfile()d with the current directory set to its
MEDIUM	scripts/extract_python_from_readme.py	18	# This function contains 95% CoPilot vibes by volume
MEDIUM	packages/python/stitch/docs/source/conf.py	6	# This file is execfile()d with the current directory set to its

Deep Nesting32 hits · 32 pts

Severity	File	Line
LOW	guidance/_schema.py	184
LOW	guidance/_grammar.py	61
LOW	guidance/_ast.py	682
LOW	guidance/_parser.py	324
LOW	guidance/_guidance.py	129
LOW	guidance/_guidance.py	140
LOW	guidance/metrics/_metrics.py	126
LOW	guidance/trace/_trace.py	357
LOW	guidance/library/_json.py	13
LOW	guidance/library/_substring.py	11
LOW	guidance/models/_mock.py	117
LOW	guidance/models/_openai_base.py	168
LOW	guidance/models/_openai_base.py	336
LOW	guidance/models/_llama_cpp.py	81
LOW	guidance/models/_transformers.py	217
LOW	guidance/models/_transformers.py	444
LOW	guidance/models/broken_models/_vertexai.py	21
LOW	guidance/models/broken_models/_vertexai.py	174
LOW	guidance/models/experimental/_sglang.py	99
LOW	guidance/models/experimental/_litellm.py	209
LOW	guidance/models/experimental/_vllm.py	29
LOW	guidance/models/_engine/_engine.py	94
LOW	guidance/models/_engine/_interpreter.py	65
LOW	guidance/models/_base/_model.py	115
LOW	guidance/models/_base/_model.py	161
LOW	guidance/models/_base/_model.py	361
LOW	guidance/visual/_renderer.py	199
LOW	guidance/visual/_renderer.py	329
LOW	guidance/visual/_renderer.py	524
LOW	guidance/visual/_renderer.py	541
LOW	guidance/visual/_trace.py	17
LOW	tests/unit/test_ll.py	62

Redundant / Tautological Comments18 hits · 29 pts

Severity	File	Line	Snippet
LOW	guidance/debug.py	27	# Check if the auto renderer has a JupyterWidgetRenderer inside
LOW	guidance/debug.py	53	# Check if the auto renderer has a JupyterWidgetRenderer inside
LOW	guidance/debug.py	81	# Check if the auto renderer has a JupyterWidgetRenderer inside
LOW	guidance/models/_transformers.py	299	# Check if the tokenizer has a bos_token attribute, and if it does, check
LOW	guidance/models/broken_models/_azureai_studio.py	123	# # Check if the result is already in the cache
LOW	guidance/models/_engine/_engine.py	315	# Check if the accumulated text ends with any stop string
LOW	guidance/models/_engine/_engine.py	357	# Check if we've accumulated enough to match the stop string
LOW	guidance/models/_engine/_engine.py	426	# Set flag to indicate this is an injection backtrack
LOW	guidance/models/_engine/_engine.py	474	# Set flag to indicate this is an injection backtrack
LOW	guidance/models/_engine/_interpreter.py	87	# Check if this is an injection backtrack (should happen before adding text)
LOW	guidance/models/_base/_model.py	181	# Set start_index to the current length
LOW	guidance/models/_base/_model.py	392	# Check if the thread is still alive
LOW	guidance/visual/_renderer.py	482	# Check if message has diverged from prev messages
LOW	guidance/visual/_trace.py	32	# Check if any input is a role opener or closer
LOW	guidance/visual/_trace.py	93	# Check if any input in active role is a RoleCloserInput
LOW	tests/unit/test_decorator.py	415	# Check if the object was garbage collected
LOW	tests/unit/test_decorator.py	428	# Check if the object was garbage collected
LOW	tests/unit/test_decorator.py	444	# Check if the object was garbage collected

Cross-Language Confusion3 hits · 20 pts

Severity	File	Line	Snippet
HIGH	tests/unit/library/json/test_allOf.py	352	# valid: foo is null, bar is equal to 5, baz is null
HIGH	tests/unit/library/json/test_allOf.py	443	# valid: foo is null, bar is equal to 5, baz is null
HIGH	packages/python/stitch/stitch/tests/conftest.py	43	_widget_attrs["_comm_default"] = getattr(Widget, "_comm_default", undefined)

Excessive Try-Catch Wrapping10 hits · 10 pts

Severity	File	Line	Snippet
LOW	guidance/metrics/_metrics.py	93	except Exception as e: # noqa BLE001
LOW	guidance/metrics/_metrics.py	141	except Exception as e: # noqa BLE001
LOW	guidance/metrics/_metrics.py	177	except Exception as e:
LOW	guidance/models/_transformers.py	310	except Exception as e:
LOW	guidance/models/broken_models/_vertexai.py	132	except Exception as e: # TODO: add retry logic
LOW	guidance/visual/_renderer.py	153	except Exception: # noqa: BLE001
LOW	guidance/visual/_renderer.py	195	except Exception as _: # noqa: BLE001
LOW	guidance/visual/_renderer.py	237	except Exception as _: # noqa: BLE001
LOW	tests/unit/test_visual.py	82	except Exception as e:
LOW	tests/model_specific/test_visual.py	51	except Exception as e:

AI Slop Vocabulary2 hits · 3 pts

Severity	File	Line	Snippet
LOW	guidance/models/_transformers.py	127	# (that will just add extra spaces during an encode-decode cycle)
LOW	guidance/models/_engine/_engine.py	614	# If we have top_k, we can just return the first one

Fake / Example Data3 hits · 3 pts

Severity	File	Line	Snippet
LOW	tests/model_specific/test_transformers.py	35	big_opts = ["Lorem ipsum dolor sit amet", "Duis aute irure dolor "]
LOW	tests/model_specific/test_transformers.py	35	big_opts = ["Lorem ipsum dolor sit amet", "Duis aute irure dolor "]
LOW	tests/model_integration/library/test_subgrammar.py	62	lm += "John Doe's name, age, and birthday:\n"

Slop Phrases1 hit · 2 pts

Severity	File	Line	Snippet
LOW	guidance/models/broken_models/_lite_llm.py	139	# # make sure you don't try and instruct the same model twice

Overly Generic Function Names2 hits · 2 pts

Severity	File	Line	Snippet
LOW	tests/model_integration/test_model.py	41	def my_function(lm):
LOW	tests/model_integration/test_model.py	77	def my_function(lm):

Score History

Severity Breakdown

Pattern Findings