Unresolved reference for 'rule' in 'run' section

[BertBog]

Hey,

When I'm referencing the 'rule' variable in the python code of the 'run' section, it gets flagged as an unresolved reference, but the code itself works fine.
Would it be possible to fix this? For other variables such as 'threads' or 'input' it works fine.

Best regards,
Bert

[iromeo]

@BertBog could you provide a code example for this issue? What rule is used for, is it your own variable or some provided by snakemake?

[BertBog]

We mainly use it to log information about rule execution to a database. But a basic use case would be something like this:

rule do_something:
    output:
        TXT = "test_file.txt"
    run:
        print("Executing rule: {}".format(rule))
        with open(output.TXT, 'w') as handle:
            handle.write('done\n')

[iromeo]

Oh, I don't know about this feature, thx. I'll add support for it in future versions, need to investigate snakemake sources, what API is available for rule variable, what is it's type, etc.

[iromeo]

Updated:
This var is available as a parameter of run wrapper function generated by snakemake, e.g.:

@workflow.run
def __rule_do_something(input, output, params, wildcards, threads, resources, log, version, rule, conda_env, container_img, singularity_args, use_singularity, env_modules, bench_record, jobid, is_shell, bench_iteration, cleanup_scripts, shadow_dir, edit_notebook):
   ...

Run function is generated by snakemake.parser.Run class

[iromeo]

Error not shown for 'rule' and 'jobid', also rule is in completion list: