Dockerfiles with different file names are not supported about dockerfile-parse

[chmeliik]

Hi @ElijahAhianyo, thanks for the report!

As an immediate workaround, you may be able to pass the [dD]ockerfile via the fileobj argument instead of by path:

import dockerfile_parse

with open('./dockerfile', 'rb') as f:
    dockerfile = dockerfile_parse.DockerfileParser(fileobj=f)
    # do stuff with dockerfile

# can't use dockerfile anymore, fileobj is closed

Or, if using a real file object is not convenient:

import io
import dockerfile_parse

with open('./dockerfile', 'rb') as f:
    in_memory_file = io.BytesIO(f.read())

dockerfile = dockerfile_parse.DockerfileParser(fileobj=in_memory_file)
# note that writes to the dockerfile (e.g. via the `envs` or `labels` attributes)
#   will only be reflected in the in_memory_file, not on disk

[chmeliik]

As for fixing the problem: maybe it would be good to support any arbitrary filename, rather than just dockerfile and Dockerfile?

For example, podman also supports the Containerfile name: https://docs.podman.io/en/latest/markdown/podman-build.1.html

Not quite sure if there is a nice way to do that while preserving backwards compatibility. Maybe the self.dockerfile_path attribute would have to be smarter:

@property
def dockerfile_path(self):
    if os.path.isfile(self._path):
        return self._path
    else:
        return os.path.join(self._path, DOCKERFILE_FILENAME)

[ElijahAhianyo]

Hi @ElijahAhianyo, thanks for the report!

As an immediate workaround, you may be able to pass the [dD]ockerfile via the fileobj argument instead of by path:

import dockerfile_parse

with open('./dockerfile', 'rb') as f:
    dockerfile = dockerfile_parse.DockerfileParser(fileobj=f)
    # do stuff with dockerfile

# can't use dockerfile anymore, fileobj is closed

Or, if using a real file object is not convenient:

import io
import dockerfile_parse

with open('./dockerfile', 'rb') as f:
    in_memory_file = io.BytesIO(f.read())

dockerfile = dockerfile_parse.DockerfileParser(fileobj=in_memory_file)
# note that writes to the dockerfile (e.g. via the `envs` or `labels` attributes)
#   will only be reflected in the in_memory_file, not on disk

Hey, @chmeliik Thanks for getting back to me. Tried out your suggestion and seems to work. However, the only downside is having to use the DockerfileParser object while the file is opened or using a yield rather than return in the case where the object is created in another function, but this shouldn't be a problem as I have a work-around for this. Thanks! :)

[MartinBasti]

Can we close this issue then?

[ElijahAhianyo]

ah yes sure