CLI-287: add ignore parameter toImage. add_local_dir and Image. copy_local_dir methods

[kramstrom]

• Adds an ignore parameter to our Image add_local_dir and copy_local_dir methods. It is similar to the condition method on Mount methods but instead operates on a Path object. It takes either a list of string patterns to ignore which follows the dockerignore syntax implemented in our PatternMatcher class using a new LocalFileFilter class which wraps around it, or you can pass in a callable which allows for more flexible selection of files.

Usage:

img.add_local_dir(
  "./local-dir", 
  remote_path="/remote-path", 
  ignore=LocalFileFilter("**/*", "!*.txt") # ignore everything except files ending with .txt
)

img.add_local_dir(
  ignore=~LocalFileFilter("**/*.py") # can be inverted for when inclusion filters are simpler to write
)

img.add_local_dir(
  ...,
  ignore=["**/*.py", "!module/*.py"] # ignore all .py files except those in the module directory
)

img.add_local_dir(
  ...,
  ignore=lambda fp: fp.is_relative_to("somewhere") # use a custom callable
)

which will add the ./local-dir directory to the image but ignore all files except .txt files

[mwaskom]

Just a drive-by; saw it's still WIP so apologies if you're thinking about these already.

[mwaskom]

Do we need to make any changes to Mount if we're planning to deprecate it as public API? I could see the argument that it would be confusing to have an inversion between the public interface / internal implementation I guess.

[kramstrom]

Yeah I think the inversion is annoying but also since the ignore callable works on Path objects and the condition we have for mount methods only allows str you would basically have to wrap every ignore to work on strings instead

[kramstrom]

As per @freider's comment below I opted to add a private method to the Mount object for the image methods to use instead and leave the signature of the Mount copy & add methods as is

[freider]

Maybe this should be called "IgnorePatterns" or something, and make it clear in that it excludes on True values. The word "Filter" and some of these docstrings make it sound like its the other way around

[kramstrom]

Hm, this class in itself doesn't exclude or include specifically though, I guess that's more how it's used in the Image methods, but I'm open to renaming it, but maybe something like FilePathPatternMatcher or something to show that it's related to our PatternMatcher?

[mwaskom]

I'm still a little confused about why we need to be wrapping our own PatternMatcher object here