degal: degal/filesystem.py@77abe8dca695 (annotated)

51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	1	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	2	Filesystem path handling
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	3	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	4
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	5	import os, os.path, errno
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	6	import codecs
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	7
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	8	class Node (object) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	9	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	10	A filesystem object is basically just complicated representation of a path.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	11
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	12	On the plus side, it has a parent node and can handle unicode/binary paths.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	13	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	14
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	15	# the binary name
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	16	fsname = None
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	17
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	18	# the unicode name
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	19	name = None
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	20
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	21	def decode_fsname (self, fsname) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	22	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	23	Decode the given raw byte string representing a filesystem name into an user-readable unicode name.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	24
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	25	XXX: currently just hardcoded as utf-8
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	26	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	27
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	28	return fsname.decode('utf-8', 'replace')
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	29
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	30	def encode_name (self, name) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	31	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	32	Returns a suitable fsname for the given unicode name or strict ASCII str
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	33
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	34	XXX: currently just hardcoded as utf-8
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	35	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	36
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	37	# this should fail for non-ASCII str
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	38	return name.encode('utf-8')
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	39
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	40	@classmethod
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	41	def from_node (cls, node) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	42	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	43	Construct from a Node object
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	44	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	45
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	46	return cls(node.parent, node.fsname, node.name, node.config)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	47
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	48	def __init__ (self, parent, fsname=None, name=None, config=None) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	49	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	50	Initialize the node with a parent and both name/fsname.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	51
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	52	If not given, fsname is encoded from name, or name decoded from fsname, using encode/decode_name.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	53
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	54	If parent is given, but both fsname and name are None, then this node will be equal to the parent.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	55	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	56
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	57	assert not fsname or isinstance(fsname, str)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	58
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	59	if parent and not fsname and not name :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	60	# no name given -> we're the same as parent
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	61	self.parent, self.config, self.fsname, self.name = parent.parent, parent.config, parent.fsname, parent.name
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	62
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	63	else :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	64	# store
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	65	self.parent = parent
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	66
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	67	# config, either as given, or copy from parent
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	68	if config :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	69	self.config = config
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	70
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	71	else :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	72	self.config = parent.config
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	73
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	74	# fsname
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	75	if fsname :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	76	self.fsname = fsname
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	77
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	78	else :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	79	self.fsname = self.encode_name(name)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	80
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	81	# name
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	82	if name :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	83	self.name = name
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	84
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	85	else :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	86	self.name = self.decode_fsname(fsname)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	87
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	88	def subnode (self, name) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	89	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	90	Returns a Node object representing the given name behind this node.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	91
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	92	The name should either be a plain ASCII string or unicode object.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	93	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	94
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	95	return Node(self, name=name)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	96
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	97	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	98	def path (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	99	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	100	Build and return the real filesystem path for this node
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	101	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	102
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	103	# build using parent path and our fsname
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	104	return os.path.join(self.parent.path, self.fsname)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	105
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	106	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	107	def unicodepath (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	108	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	109	Build and return the fake unicode filesystem path for this node
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	110	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	111
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	112	# build using parent unicodepath and our name
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	113	return os.path.join(self.parent.path, self.name)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	114
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	115	def exists (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	116	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	117	Tests if this node exists on the physical filesystem
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	118	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	119
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	120	return os.path.exists(self.path)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	121
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	122	def is_dir (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	123	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	124	Tests if this node represents a directory on the filesystem
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	125	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	126
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	127	return os.path.isdir(self.path)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	128
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	129	def is_file (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	130	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	131	Tests if this node represents a normal file on the filesystem
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	132	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	133
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	134	return os.path.isfile(self.path)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	135
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	136	def path_from (self, node) :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	137	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	138	Returns a relative path to this node from the given node
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	139	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	140
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	141	XXX
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	142
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	143	def stat (self, soft=False) :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	144	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	145	Returns the os.stat struct for this node.
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	146
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	147	If `soft` is given, returns None if this node doesn't exist
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	148	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	149
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	150	try :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	151	return os.stat(self.path)
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	152
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	153	except OSError, e :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	154	# trap ENOENT for soft
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	155	if soft and e.errno == errno.ENOENT :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	156	return None
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	157
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	158	else :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	159	raise
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	160
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	161	def __str__ (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	162	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	163	Returns the raw filesystem path
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	164	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	165
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	166	return self.path
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	167
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	168	def __unicode__ (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	169	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	170	Returns the human-readable path
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	171	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	172
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	173	return self.unicodepath
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	174
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	175	def __repr__ (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	176	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	177	Returns a str representing this dir
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	178	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	179
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	180	return "Node(%r, %r)" % (self.parent.path, self.fsname)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	181
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	182	def __cmp__ (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	183	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	184	Comparisons between Nodes
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	185	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	186
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	187	return cmp((self.parent, self.name), (other.parent, other.name))
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	188
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	189	class File (Node) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	190	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	191	A file. Simple, eh?
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	192	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	193
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	194	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	195	def basename (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	196	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	197	Returns the "base" part of this file's name, i.e. the filename without the extension
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	198	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	199
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	200	basename, _ = os.path.splitext(self.name)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	201
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	202	return basename
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	203
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	204	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	205	def fileext (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	206	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	207	Returns the file extension part of the file's name, without any leading dot
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	208	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	209
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	210	_, fileext = os.path.splitext(self.name)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	211
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	212	return fileext.rstrip('.')
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	213
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	214	def matchext (self, ext_list) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	215	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	216	Tests if this file's extension is part of the recognized list of extensions
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	217	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	218
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	219	return (self.fileext.lower() in ext_list)
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	220
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	221	def open (self, mode='r', encoding=None, errors=None, bufsize=None) :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	222	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	223	Wrapper for open/codecs.open
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	224	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	225
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	226	if encoding :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	227	return codecs.open(self.path, mode, encoding, errors, bufsize)
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	228
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	229	else :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	230	return open(self.path, mode, bufsize)
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	231
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	232	class Directory (Node) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	233	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	234	A directory is a node that contains other nodes.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	235	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	236
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	237	# a list of (test_func, node_type) tuples for use by children() to build subnodes with
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	238	NODE_TYPES = None
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	239
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	240	def subdir (self, name, create=False) :
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	241	"""
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	242	Returns a Directory object representing the name underneath this dir.
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	243
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	244	If the create option is given, the directory will be created if it does not exist.
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	245	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	246
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	247	dir = Directory(self, name=name)
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	248
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	249	# try and mkdir?
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	250	if create and not dir.is_dir() :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	251	dir.mkdir()
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	252
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	253	def subfile (self, name) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	254	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	255	Returns a File object representing the name underneath this dir
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	256	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	257
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	258	return Directory(self, name=name)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	259
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	260	def mkdir (self) :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	261	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	262	Create this directory with default permissions
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	263
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	264	XXX: mode argument
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	265	"""
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	266
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	267	# do it
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	268	os.mkdir(self.path)
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	269
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	270	def listdir (self, skip_dotfiles=True) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	271	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	272	Yield a series of raw fsnames for nodes in this dir
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	273	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	274
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	275	# expressed
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	276	return (fsname for fsname in os.listdir(self.path) if not (skip_dotfiles and fsname.startswith('.')))
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	277
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	278	def subnodes (self, skip_dotfiles=True, sort=True) :
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	279	"""
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	280	Yield a series of Nodes contained in this dir.
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	281
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	282	If skip_dotfiles is given, nodes that begin with a . are omitted.
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	283
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	284	If `sort` is given, the returned nodes will be in sorted order.
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	285	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	286
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	287	iter = (Node(self, fsname) for fsname in self.listdir(skip_dotfiles))
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	288
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	289	if sort :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	290	return sorted(iter)
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	291
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	292	else :
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	293	return iter
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	294
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	295	def __iter__ (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	296	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	297	Iterating over a Directory yields sub-Nodes.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	298
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	299	Dotfiles are skipped.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	300	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	301
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	302	return self.subnodes()
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	303
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	304	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	305	def root_path (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	306	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	307	Build and return a relative path to the root of this dir tree
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	308
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	309	XXX: move to node
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	310	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	311
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	312	# build using parent root_path
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	313	return os.path.join('..', self.parent.root_path)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	314
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	315	def children (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	316	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	317	Yield a series of Node subclasses representing the items in this dir.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	318
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	319	This uses self.NODE_TYPES to figure out what kind of sub-node object to build. This should be a list of
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	320	(test_func, node_type)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	321
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	322	tuples, of which the first is a function that takes a Node as it's sole argument, and returns a boolean.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	323	For the first test_func which returns True, a Node-subclass object is constructed using node_type.from_node.
55 77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	324
77abe8dca695 further work on filesystem.py (path_from proto, stat, open, subdir-create, mkdir, subnodes Tero Marttila <terom@fixme.fi> parents: 51 diff changeset	325	XXX: never used
51 0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	326	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	327
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	328	for node in self :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	329	# figure out what type to use
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	330	for test_func, node_type in self.NODE_TYPES :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	331	if test_func(node) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	332	# matches, build
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	333	yield node_type.from_node(node)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	334
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	335	else :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	336	# unknown file type!
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	337	raise Exception("unrecongized type of file: %s" % node);
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	338
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	339	# assign default Directory.NODE_TYPES
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	340	Directory.NODE_TYPES = [
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	341	(Node.is_dir, Directory),
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	342	(Node.is_file, File),
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	343	]
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	344
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	345
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	346	class Root (Directory) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	347	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	348	A special Directory that overrides the Node methods to anchor the recursion/etc at some 'real' filesystem path.
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	349	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	350
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	351	def __init__ (self, fspath, config) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	352	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	353	Construct the directory tree root at the given 'real' path, which must be a raw str
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	354	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	355
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	356	# abuse Node's concept of a "name" a bit
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	357	super(Root, self).__init__(None, fspath, config=config)
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	358
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	359	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	360	def path (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	361	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	362	Returns the raw path
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	363	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	364
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	365	return self.fsname
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	366
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	367	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	368	def unicodepath (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	369	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	370	Returns the raw decoded path
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	371	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	372
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	373	return self.name
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	374
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	375	@property
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	376	def root_path (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	377	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	378	Returns an empty string representing this dir
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	379	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	380
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	381	return ''
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	382
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	383	def __repr__ (self) :
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	384	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	385	Override Node.__repr__ to not use self.parent.path
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	386	"""
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	387
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	388	return "Root(%r)" % self.fsname
0f39cb5e4b11 start writing new structure, with config, render, filesystem modules Tero Marttila <terom@fixme.fi> parents: diff changeset	389

author	Tero Marttila <terom@fixme.fi>
	Fri, 05 Jun 2009 19:28:11 +0300
changeset 55	77abe8dca695
parent 51	0f39cb5e4b11
child 60	406da27a4be2
permissions	-rw-r--r--