Missing python interface file
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- developer-experience
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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).
- Lingua principale
- C
- Stelle
- 754
- Fork
- 190
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di VirusTotal/yara-python
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
VirusTotal/yara-python#263 · 2 commenti ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 28/100
VirusTotal/yara-python#234 · 2 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 20/100
VirusTotal/yara-python#216 ·
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
VirusTotal/yara-python#212 · 11 commenti ·
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 30/100
VirusTotal/yara-python#199 · 3 commenti ·
Tutte le issue di VirusTotal/yara-python
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
BasedHardware/omi#15662 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
-
level/task module/gcp type/bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 85/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 86/100
hapostgres/pg_auto_failover#1190 ·
-
docs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100