Python add custom property/metadata to file

Question

In Python, is it possible to add custom property/metadata to a file? For example, I need to add "FileInfo" as a new property of the file. I need a method that works on various file formats

When you say "to a file", are you referring to the Python file object or to the file itself ? — bruno desthuilliers
– bruno desthuilliers, Commented Dec 16, 2016 at 12:24

technoplato · Accepted Answer · 2020-04-23 15:23:55Z

13

Heads up: this answer only works on Linux

You can make use of extended file attributes which is a filesystem feature that do just what you want: store custom metadata along files.

In Python, this is implemented by the os module through setxattr() and getxattr() functions.

import os

os.setxattr('foo.txt', 'user.bar', b'baz')
os.getxattr('foo.txt', 'user.bar')  # => b'baz'

Note that you must prepend the xattr value with "user." otherwise this may raise an OSError.

edited Apr 23, 2020 at 15:23

technoplato

3,44125 silver badges33 bronze badges

answered May 31, 2019 at 17:49

Delgan

20k11 gold badges101 silver badges162 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

hpaknia Over a year ago

Note that the attribute is not copied if the file is copied to a new place. But moving will keep the attribute, even moving between volumes.

Lewis Morris Over a year ago

Sucks it doesn't stay when copying files.

Delgan Over a year ago

@LewisMorris You should use shutil.copy2() or cp -a which will try to preserve extended attributes.

Collectives™ on Stack Overflow

Python add custom property/metadata to file

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related