xattr.html

   1
   2 <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module xattr</title>
   4 </head><body bgcolor="#f0f0f8">
   5
   6 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
   7 <tr bgcolor="#7799ee">
   8 <td valign=bottom>&nbsp;<br>
   9 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>xattr</strong></big></big></font></td
  10 ><td align=right valign=bottom
  11 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/iusty/work/pyxattr/build/lib.linux-i686-2.3/xattr.so">/home/iusty/work/pyxattr/build/lib.linux-i686-2.3/xattr.so</a></font></td></tr></table>
  12     <p><tt>Access&nbsp;extended&nbsp;filesystem&nbsp;attributes<br>
  13 &nbsp;<br>
  14 This&nbsp;module&nbsp;gives&nbsp;access&nbsp;to&nbsp;the&nbsp;extended&nbsp;attributes&nbsp;present<br>
  15 in&nbsp;some&nbsp;operating&nbsp;systems/filesystems.&nbsp;You&nbsp;can&nbsp;list&nbsp;attributes,<br>
  16 get,&nbsp;set&nbsp;and&nbsp;remove&nbsp;them.<br>
  17 The&nbsp;last&nbsp;and&nbsp;optional&nbsp;parameter&nbsp;for&nbsp;all&nbsp;functions&nbsp;is&nbsp;a&nbsp;boolean&nbsp;<br>
  18 value&nbsp;which&nbsp;enables&nbsp;the&nbsp;'l-'&nbsp;version&nbsp;of&nbsp;the&nbsp;functions&nbsp;-&nbsp;acting<br>
  19 on&nbsp;symbolic&nbsp;links&nbsp;and&nbsp;not&nbsp;their&nbsp;destination.<br>
  20 &nbsp;<br>
  21 Example:&nbsp;<br>
  22 &gt;&gt;&gt;&nbsp;import&nbsp;xattr<br>
  23 &gt;&gt;&gt;&nbsp;xattr.<a href="#-listxattr">listxattr</a>("file.txt")<br>
  24 ('user.mime_type',)<br>
  25 &gt;&gt;&gt;&nbsp;xattr.<a href="#-getxattr">getxattr</a>("file.txt",&nbsp;"user.mime_type")<br>
  26 'text/plain'<br>
  27 &gt;&gt;&gt;&nbsp;xattr.<a href="#-setxattr">setxattr</a>("file.txt",&nbsp;"user.comment",&nbsp;"Simple&nbsp;text&nbsp;file")<br>
  28 &gt;&gt;&gt;&nbsp;xattr.<a href="#-listxattr">listxattr</a>("file.txt")<br>
  29 ('user.mime_type',&nbsp;'user.comment')<br>
  30 &gt;&gt;&gt;&nbsp;xattr.removexattr&nbsp;("file.txt",&nbsp;"user.comment")</tt></p>
  31 <p>
  32 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  33 <tr bgcolor="#eeaa77">
  34 <td colspan=3 valign=bottom>&nbsp;<br>
  35 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
  36
  37 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  38 <td width="100%"><dl><dt><a name="-getxattr"><strong>getxattr</strong></a>(...)</dt><dd><tt>Get&nbsp;the&nbsp;value&nbsp;of&nbsp;a&nbsp;given&nbsp;extended&nbsp;attribute.<br>
  39 &nbsp;<br>
  40 Parameters:<br>
  41 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string&nbsp;representing&nbsp;filename,&nbsp;or&nbsp;a&nbsp;file-like&nbsp;object,<br>
  42 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;a&nbsp;file&nbsp;descriptor;&nbsp;this&nbsp;represents&nbsp;the&nbsp;file&nbsp;on&nbsp;<br>
  43 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;which&nbsp;to&nbsp;act<br>
  44 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string,&nbsp;representing&nbsp;the&nbsp;attribute&nbsp;whose&nbsp;value&nbsp;to&nbsp;retrieve;<br>
  45 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;usually&nbsp;in&nbsp;form&nbsp;of&nbsp;system.posix_acl&nbsp;or&nbsp;user.mime_type<br>
  46 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;(optional)&nbsp;a&nbsp;boolean&nbsp;value&nbsp;(defaults&nbsp;to&nbsp;false),&nbsp;which,&nbsp;if<br>
  47 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;file&nbsp;name&nbsp;given&nbsp;is&nbsp;a&nbsp;symbolic&nbsp;link,&nbsp;makes&nbsp;the<br>
  48 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;function&nbsp;operate&nbsp;on&nbsp;the&nbsp;symbolic&nbsp;link&nbsp;itself&nbsp;instead<br>
  49 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;its&nbsp;target;</tt></dd></dl>
  50  <dl><dt><a name="-listxattr"><strong>listxattr</strong></a>(...)</dt><dd><tt>Return&nbsp;the&nbsp;tuple&nbsp;of&nbsp;attribute&nbsp;names&nbsp;from&nbsp;a&nbsp;file<br>
  51 &nbsp;<br>
  52 Parameters:<br>
  53 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string&nbsp;representing&nbsp;filename,&nbsp;or&nbsp;a&nbsp;file-like&nbsp;object,<br>
  54 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;a&nbsp;file&nbsp;descriptor;&nbsp;this&nbsp;represents&nbsp;the&nbsp;file&nbsp;to&nbsp;<br>
  55 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;be&nbsp;queried<br>
  56 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;(optional)&nbsp;a&nbsp;boolean&nbsp;value&nbsp;(defaults&nbsp;to&nbsp;false),&nbsp;which,&nbsp;if<br>
  57 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;file&nbsp;name&nbsp;given&nbsp;is&nbsp;a&nbsp;symbolic&nbsp;link,&nbsp;makes&nbsp;the<br>
  58 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;function&nbsp;operate&nbsp;on&nbsp;the&nbsp;symbolic&nbsp;link&nbsp;itself&nbsp;instead<br>
  59 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;its&nbsp;target;</tt></dd></dl>
  60  <dl><dt><a name="-removexattr"><strong>removexattr</strong></a>(...)</dt><dd><tt>Remove&nbsp;an&nbsp;attribute&nbsp;from&nbsp;a&nbsp;file<br>
  61 &nbsp;<br>
  62 Parameters:<br>
  63 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string&nbsp;representing&nbsp;filename,&nbsp;or&nbsp;a&nbsp;file-like&nbsp;object,<br>
  64 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;a&nbsp;file&nbsp;descriptor;&nbsp;this&nbsp;represents&nbsp;the&nbsp;file&nbsp;on&nbsp;<br>
  65 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;which&nbsp;to&nbsp;act<br>
  66 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string,&nbsp;representing&nbsp;the&nbsp;attribute&nbsp;to&nbsp;be&nbsp;removed;<br>
  67 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;usually&nbsp;in&nbsp;form&nbsp;of&nbsp;system.posix_acl&nbsp;or&nbsp;user.mime_type<br>
  68 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;(optional)&nbsp;a&nbsp;boolean&nbsp;value&nbsp;(defaults&nbsp;to&nbsp;false),&nbsp;which,&nbsp;if<br>
  69 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;file&nbsp;name&nbsp;given&nbsp;is&nbsp;a&nbsp;symbolic&nbsp;link,&nbsp;makes&nbsp;the<br>
  70 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;function&nbsp;operate&nbsp;on&nbsp;the&nbsp;symbolic&nbsp;link&nbsp;itself&nbsp;instead<br>
  71 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;its&nbsp;target;</tt></dd></dl>
  72  <dl><dt><a name="-setxattr"><strong>setxattr</strong></a>(...)</dt><dd><tt>Set&nbsp;the&nbsp;value&nbsp;of&nbsp;a&nbsp;given&nbsp;extended&nbsp;attribute.<br>
  73 Be&nbsp;carefull&nbsp;in&nbsp;case&nbsp;you&nbsp;want&nbsp;to&nbsp;set&nbsp;attributes&nbsp;on&nbsp;symbolic<br>
  74 links,&nbsp;you&nbsp;have&nbsp;to&nbsp;use&nbsp;all&nbsp;the&nbsp;5&nbsp;parameters;&nbsp;use&nbsp;0&nbsp;for&nbsp;the&nbsp;<br>
  75 flags&nbsp;value&nbsp;if&nbsp;you&nbsp;want&nbsp;the&nbsp;default&nbsp;behavior&nbsp;(create&nbsp;or&nbsp;replace)<br>
  76 &nbsp;<br>
  77 Parameters:<br>
  78 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string&nbsp;representing&nbsp;filename,&nbsp;or&nbsp;a&nbsp;file-like&nbsp;object,<br>
  79 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;a&nbsp;file&nbsp;descriptor;&nbsp;this&nbsp;represents&nbsp;the&nbsp;file&nbsp;on&nbsp;<br>
  80 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;which&nbsp;to&nbsp;act<br>
  81 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string,&nbsp;representing&nbsp;the&nbsp;attribute&nbsp;whose&nbsp;value&nbsp;to&nbsp;set;<br>
  82 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;usually&nbsp;in&nbsp;form&nbsp;of&nbsp;system.posix_acl&nbsp;or&nbsp;user.mime_type<br>
  83 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;a&nbsp;string,&nbsp;possibly&nbsp;with&nbsp;embedded&nbsp;NULLs;&nbsp;note&nbsp;that&nbsp;there<br>
  84 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;are&nbsp;restrictions&nbsp;regarding&nbsp;the&nbsp;size&nbsp;of&nbsp;the&nbsp;value,&nbsp;for<br>
  85 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;example,&nbsp;for&nbsp;ext2/ext3,&nbsp;maximum&nbsp;size&nbsp;is&nbsp;the&nbsp;block&nbsp;size<br>
  86 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;(optional)&nbsp;flags;&nbsp;if&nbsp;0&nbsp;or&nbsp;ommited&nbsp;the&nbsp;attribute&nbsp;will&nbsp;be&nbsp;<br>
  87 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;created&nbsp;or&nbsp;replaced;&nbsp;if&nbsp;XATTR_CREATE,&nbsp;the&nbsp;attribute&nbsp;<br>
  88 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;will&nbsp;be&nbsp;created,&nbsp;giving&nbsp;an&nbsp;error&nbsp;if&nbsp;it&nbsp;already&nbsp;exists;<br>
  89 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;XATTR_REPLACE,&nbsp;the&nbsp;attribute&nbsp;will&nbsp;be&nbsp;replaced,<br>
  90 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;giving&nbsp;an&nbsp;error&nbsp;if&nbsp;it&nbsp;doesn't&nbsp;exists;<br>
  91 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;(optional)&nbsp;a&nbsp;boolean&nbsp;value&nbsp;(defaults&nbsp;to&nbsp;false),&nbsp;which,&nbsp;if<br>
  92 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;file&nbsp;name&nbsp;given&nbsp;is&nbsp;a&nbsp;symbolic&nbsp;link,&nbsp;makes&nbsp;the<br>
  93 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;function&nbsp;operate&nbsp;on&nbsp;the&nbsp;symbolic&nbsp;link&nbsp;itself&nbsp;instead<br>
  94 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;its&nbsp;target;</tt></dd></dl>
  95 </td></tr></table><p>
  96 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  97 <tr bgcolor="#55aa55">
  98 <td colspan=3 valign=bottom>&nbsp;<br>
  99 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
 100
 101 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 102 <td width="100%"><strong>XATTR_CREATE</strong> = 1<br>
 103 <strong>XATTR_REPLACE</strong> = 2</td></tr></table>
 104 </body></html>