Reference directories when using config file

[ghost]

It is told that if reference_directories list is empty, they become equal to test_directories list (which is strictly required in any variant).

But it is not told (at least it is not cleared out) that if using tool with -c flag, reference_directories list should be provided non-empty in config file and it will not become equal to (copied from) test_directories list.

And this 'cross-confusing rule' got confirmed when I've inspected the code here (copy) and here (no copy) that empty reference_directories is only allowed for full-optioned CLI run, but not with -c-run.

Can you state this restriction more clear in the docs or, probably better - update the -c mode to behave equal to full-optioned run?

[blingenf]

I believe the configuration file also requires noise_threshold, guarantee_threshold, and display_threshold to be explicitly specified which is not true for the CLI. I don't remember my original reasoning for that, but the configuration definitely should behave identically to the CLI method. I'll adjust how the defaults are handled.

[ghost]

Thank you for quick response!

Maybe moving code before reading config file to place right after could help, but I cannot be sure as I did not dig into the sources much yet.

Just discovered that for API CodeDetector object with config=dict option the reference_directories are copied from test_directories, which is a good point in this case.

[blingenf]

I decided it was best to deal with the root cause of this issue, which is allowing both a config file and specific parameters to be passed as arguments to the CopyDetector initializer. For future versions I'm planning on separating these two initialization methods. To initialize with a config file you would need CopyDetector.from_config(config)

The PR is here: #16. If this change would be particularly disruptive for your project feel free to comment on the PR.

[ghost]

It's not a big deal, I am ready to update my project once the new release is coming to the PyPi, since I am using this tool as the pip requirement.

[ghost]

Is it correct that from now API allows only 2 options: a) full config parameters set up and b) passing config file instead? So I need to save current config dict to file first and then pass the file path to process?
Asking because the PR description says it's a config file, but from the code it's still a config dict object argument.

[blingenf]

Is it correct that from now API allows only 2 options: a) full config parameters set up and b) passing config file instead? So I need to save current config dict to file first and then pass the file path to process? Asking because the PR description says it's a config file, but from the code it's still a config dict object argument.

Sorry, the PR description could have been more clear. It's still a dict object, so you won't have to save it first.

[blingenf]

The fix is in version 0.4.1 and is now on pypi. Your existing code should still work but when you switch to the from_config function make sure to require copydetect>=0.4.1.