pypyr.steps.tar permalink

archive & extract tar files with compression permalink

Archive and extract tars with or without compression.

- name: pypyr.steps.tar
  comment: extract & archive tar
            - in: /path/my.tar
              out: /out/path
            - in: /dir/to/archive
              out: /out/destination.tar
        format: '' # optional. '' | gz | bz2 | xz

Either extract or archive should exist, or both. But not neither.

Optionally, you can also specify the tar compression format with format. Available options for format:

  • '' - no compression
  • gz - (gzip)
  • bz2 - (bzip2)
  • xz - (lzma)

If you do not specify format, it defaults to xz (lzma).

This step will run whatever combination of Extract and Archive you specify. Regardless of combination, execution order is Extract, then Archive. So you could archive select files that you just extracted in the same step.

You can use substitutions to format all the inputs from context. This allows you to set in and out paths dynamically at run-time.

Never extract archives from untrusted sources without prior inspection. It is possible for extraction to create files outside of your out path, e.g. members that have absolute filenames starting with / or filenames with two dots ..

See a worked example for tar.

tar extract permalink

tar['extract'] must exist. It’s a list of dictionaries.

key1: here
key2: tar.xz
    - in: path/to/my.tar.xz
      out: /path/extract/{key1}
    - in: another/{key2}
      out: .

This will:

  • Extract path/to/my.tar.xz to /path/extract/here
  • Extract another/tar.xz to the current execution directory
    • This is the directory you’re running pypyr from, not the pypyr pipeline working directory you set with the --dir flag.

tar archive permalink

tar['archive'] must exist. It’s a list of dictionaries.

key1: destination.tar.xz
key2: value2
    - in: path/{key2}/dir
      out: path/to/{key1}
    - in: another/my.file
      out: ./my.tar.xz

This will:

  • Archive directory path/value2/dir to path/to/destination.tar.xz,
  • Archive file another/my.file to ./my.tar.xz
last updated on .