Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modifying yara-python docs to reflect existence of strict_escape bool #2079

Merged
merged 2 commits into from
May 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/yarapython.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,12 +119,15 @@ should pass the ``externals`` parameter to the ``compile`` method. For example:
The ``externals`` parameter must be a dictionary with the names of the variables
as keys and an associated value of either string, integer or boolean type.

The ``compile`` method also accepts the optional boolean argument
The ``compile`` method also accepts the optional boolean arguments telling yara-python
how to deal with warnings. The first argument of this nature is
``error_on_warning``. This arguments tells YARA to raise an exception when a
warning is issued during compilation. Such warnings are typically issued when
your rules contains some construct that could be slowing down the scanning.
The default value for the ``error_on_warning`` argument is False.

The default value for the ``error_on_warning`` argument is False. The second argument of
this type is another boolean, ``strict_escape``, when enabled this causes YARA to produce
a warning when rules contain mis-escaped characters. The default value for the ``strict_escape``
argument is False.

In all cases ``compile`` returns an instance of the class :py:class:`yara.Rules`
Rules. This class has a ``save`` method that can be used to save the compiled
Expand Down
Loading