Add To Archive

Add file(s) to the archive

Arguments

Argument Type Default value Description
filesList, strnullname of the file, or list of files, to add
archive_namestrnullfilename of the archive
folderstr, NoneNonename of the folder where the file will be added, relative path within the archive
param files:name of the file, or list of files, to add
param archive_name:
 filename of the archive
param folder:name of the folder where the file will be added, relative path within the archive
return:None

This keyword adds a file or list of files into an existing archive. Files can be added to archive structure with relative path using argument folder.

Examples


Add To Archive  extrafile.txt  myfiles.zip
Add To Archive  stat.png       archive.tar.gz  images
@{files}        Create List    filename1.txt   filename2.txt
Add To Archive  ${files}       files.tar

Archive Folder With Tar

Create a tar/tar.gz archive of a folder

Arguments

Argument Type Default value Description
folderstrnullname of the folder to archive
archive_namestrnullfilename of the archive
recursiveboolFalseshould sub directories be included, default is False
includestr, NoneNonedefine file pattern to include in the package, default is None which means all files are included
excludestr, NoneNonedefine file pattern to exclude from the package, default is None
param folder:name of the folder to archive
param archive_name:
 filename of the archive
param recursive:
 should sub directories be included, default is False
param include:define file pattern to include in the package, default is None which means all files are included
param exclude:define file pattern to exclude from the package, default is None
return:None

This keyword creates an TAR or TAR.GZ archive of a local folder. Type of archive is determined by the file extension. By default subdirectories are not included, but they can included using recursive argument.

To include only certain files, like TXT files, the argument include can be used. Similarly to exclude certain file, like dotfiles, the argument exclude can be used.

Examples


Archive Folder With TAR  ${CURDIR}${/}documents  documents.tar
Archive Folder With TAR  ${CURDIR}${/}tasks      tasks.tar.gz   include=*.robot
Archive Folder With TAR  ${CURDIR}${/}tasks      tasks.tar      exclude=/.*
Archive Folder With TAR  ${CURDIR}${/}documents  documents.tar  recursive=True

Archive Folder With Zip

Create a zip archive of a folder

Arguments

Argument Type Default value Description
folderstrnullname of the folder to archive
archive_namestrnullfilename of the archive
recursiveboolFalseshould sub directories be included, default is False
includestr, NoneNonedefine file pattern to include in the package, default is None which means all files are included
excludestr, NoneNonedefine file pattern to exclude from the package, default is None
compressionstrstoredtype of package compression method, default is "stored"
param folder:name of the folder to archive
param archive_name:
 filename of the archive
param recursive:
 should sub directories be included, default is False
param include:define file pattern to include in the package, default is None which means all files are included
param exclude:define file pattern to exclude from the package, default is None
param compression:
 type of package compression method, default is "stored"
return:None

This keyword creates an ZIP archive of a local folder. By default subdirectories are not included, but they can be included using the recursive argument.

To include only certain files, like TXT files, the argument include can be used. Similarly to exclude certain files, like dotfiles, the argument exclude can be used.

Compression methods:

  • stored, default
  • deflated
  • bzip2
  • lzma

Examples


Archive Folder With Zip  ${CURDIR}${/}documents  mydocs.zip
Archive Folder With Zip  ${CURDIR}${/}tasks      robottasks.zip   include=*.robot
Archive Folder With Zip  ${CURDIR}${/}tasks      no_dotfiles.zip  exclude=/.*
Archive Folder With Zip  ${CURDIR}${/}documents  documents.zip    recursive=True
Archive Folder With Zip  ${CURDIR}               packagelzma.zip  compression=lzma
Archive Folder With Zip  ${CURDIR}               bzipped.zip      compression=bzip2

Extract Archive

Extract files from archive into local directory

Arguments

Argument Type Default value Description
archive_namestrnullfilename of the archive
pathstr, NoneNonefilepath to extract file into, default is current working directory
membersList, str, NoneNonelist of files to extract from archive, by default all files in archive are extracted
param archive_name:
 filename of the archive
param path:filepath to extract file into, default is current working directory
param members:list of files to extract from archive, by default all files in archive are extracted
return:None

This keyword supports extracting files from zip, tar and tar.gz archives.

By default file is extracted into current working directory, but path argument can be set to define extraction path.

Examples


Extract Archive    myfiles.zip   ${CURDIR}${/}extracted
@{files}           Create List   filename1.txt    filename2.txt
Extract Archive    archive.tar   C:${/}myfiles${/}  ${files}

Extract File From Archive

Extract a file from archive into local directory

Arguments

Argument Type Default value Description
filenamestrnullname of the file to extract
archive_namestrnullfilename of the archive
pathstr, NoneNonefilepath to extract file into, default is current working directory
param filename:name of the file to extract
param archive_name:
 filename of the archive
param path:filepath to extract file into, default is current working directory
return:None

This keyword supports extracting a file from zip, tar and tar.gz archives.

By default file is extracted into current working directory, but path argument can be set to define extraction path.

Examples


Extract File From Archive    extrafile.txt   myfiles.zip
Extract File From Archive    background.png  images.tar.gz  ${CURDIR}${/}extracted

Get Archive Info

Get information about the archive

Arguments

Argument Type Default value Description
archive_namestrnullfilename of the archive
param archive_name:
 filename of the archive
return:dictionary variable containing the keys filename, filemode, size, mtime, modified

Returns following file attributes in a dictionary:

  • filename
  • filemode
  • size
  • mtime
  • last modification time in format %d.%m.%Y %H:%M:%S

Examples


&{archiveinfo}   Get Archive Info    myfiles.zip

List Archive

List files in an archive

Arguments

Argument Type Default value Description
archive_namestrnullfilename of the archive
param archive_name:
 filename of the archive
return:dictionary variable containing the keys name, size, mtime, modified

Returns list of files, where each file in a list is a dictionary with following attributes:

  • name
  • size
  • mtime
  • last modification time in format %d.%m.%Y %H:%M:%S

Examples


@{files}   List Archive    myfiles.zip
FOR  ${file}  IN   ${files}
    Log  ${file}[filename]
    Log  ${file}[size]
    Log  ${file}[mtime]
END