Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Missing python interface file

Ouverte
  • Quelque chose ne va pas ?
#218 0 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
48/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
developer-experience

Piste de recherche

Review the documented yara-python API and the proposed .pyi interface, then check how the compiled package is laid out in this repository. Compare the result with mypy stubgen output and verify the stubs support VSCode type hinting and code completion. Done means a correct .pyi file is included in the package with the public functions and classes represented.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

The compiled yara-python is missing a python interface file (.pyi).

Without such an interface definition, support in IDEs is quite limited (no type hinting, no code completion).

I've created a small interface file based on the documentation, which is definitely not 100% correct, but enough to enable code completion and type hinting in VSCode:

from typing import IO, Callable, Dict, List, Tuple, Union

class Match:

    rule: str
    namespace: str
    tags: List[str]
    meta: Dict[str, str]
    strings: List[Tuple[int, str, str]]

class Rules:
    def match(
        self,
        filepath: str = "",
        pid: int = 0,
        data: Union[str, bytes] = "",
        externals: dict = {},
        callback: Callable = lambda x: x,
        fast: bool = False,
        timeout: int = -1,
        modules_data: dict = {},
        modules_callback: Callable = lambda x: x,
        warnings_callback: Callable = lambda x: x,
        which_callbacks: int = 0,
        console_callback: Callable = lambda x: x,
    ) -> List[Match]:
        pass
    def save(self, filepath: str = "", file: IO = None) -> None:
        pass

def compile(
    filepath: str = "",
    source: str = "",
    file: IO = None,
    filepaths: dict = {},
    sources: dict = {},
    externals: dict = {},
    includes: bool = True,
    error_on_warning: bool = False,
) -> Rules:
    pass

def load(filepath: str = "", file: IO = None) -> Rules:
    pass

def set_config(
    stack_size: int = -1, max_strings_per_rule: int = -1, max_match_data: int = -1
) -> None:
    pass

Adding a correct .pyi file to this repo, which can also be autogenerated using mypys stubgen (https://mypy.readthedocs.io/en/stable/stubgen.html), would obviously be the preferred solution.
I already tried autogeneration with stubgen, which did not work that good (function parameters and type hints were missing).

Langage dominant
C
Étoiles
755
Forks
190
Aucune PR mergée en 30 j

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de VirusTotal/yara-python

Toutes les issues de VirusTotal/yara-python

Issues similaires

Plus d'issues C

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.