Python code coverage for Lib/plat-os2emx/grp.py

#	count	content
1	n/a	# this module is an OS/2 oriented replacement for the grp standard
2	n/a	# extension module.
3	n/a
4	n/a	# written by Andrew MacIntyre, April 2001.
5	n/a	# updated July 2003, adding field accessor support
6	n/a
7	n/a	# note that this implementation checks whether ":" or ";" as used as
8	n/a	# the field separator character.
9	n/a
10	n/a	"""Replacement for grp standard extension module, intended for use on
11	n/a	OS/2 and similar systems which don't normally have an /etc/group file.
12	n/a
13	n/a	The standard Unix group database is an ASCII text file with 4 fields per
14	n/a	record (line), separated by a colon:
15	n/a	- group name (string)
16	n/a	- group password (optional encrypted string)
17	n/a	- group id (integer)
18	n/a	- group members (comma delimited list of userids, with no spaces)
19	n/a
20	n/a	Note that members are only included in the group file for groups that
21	n/a	aren't their primary groups.
22	n/a	(see the section 8.2 of the Python Library Reference)
23	n/a
24	n/a	This implementation differs from the standard Unix implementation by
25	n/a	allowing use of the platform's native path separator character - ';' on OS/2,
26	n/a	DOS and MS-Windows - as the field separator in addition to the Unix
27	n/a	standard ":".
28	n/a
29	n/a	The module looks for the group database at the following locations
30	n/a	(in order first to last):
31	n/a	- ${ETC_GROUP} (or %ETC_GROUP%)
32	n/a	- ${ETC}/group (or %ETC%/group)
33	n/a	- ${PYTHONHOME}/Etc/group (or %PYTHONHOME%/Etc/group)
34	n/a
35	n/a	Classes
36	n/a	-------
37	n/a
38	n/a	None
39	n/a
40	n/a	Functions
41	n/a	---------
42	n/a
43	n/a	getgrgid(gid) - return the record for group-id gid as a 4-tuple
44	n/a
45	n/a	getgrnam(name) - return the record for group 'name' as a 4-tuple
46	n/a
47	n/a	getgrall() - return a list of 4-tuples, each tuple being one record
48	n/a	(NOTE: the order is arbitrary)
49	n/a
50	n/a	Attributes
51	n/a	----------
52	n/a
53	n/a	group_file - the path of the group database file
54	n/a
55	n/a	"""
56	n/a
57	n/a	import os
58	n/a
59	n/a	# try and find the group file
60	n/a	__group_path = []
61	n/a	if 'ETC_GROUP' in os.environ:
62	n/a	__group_path.append(os.environ['ETC_GROUP'])
63	n/a	if 'ETC' in os.environ:
64	n/a	__group_path.append('%s/group' % os.environ['ETC'])
65	n/a	if 'PYTHONHOME' in os.environ:
66	n/a	__group_path.append('%s/Etc/group' % os.environ['PYTHONHOME'])
67	n/a
68	n/a	group_file = None
69	n/a	for __i in __group_path:
70	n/a	try:
71	n/a	__f = open(__i, 'r')
72	n/a	__f.close()
73	n/a	group_file = __i
74	n/a	break
75	n/a	except:
76	n/a	pass
77	n/a
78	n/a	# decide what field separator we can try to use - Unix standard, with
79	n/a	# the platform's path separator as an option. No special field conversion
80	n/a	# handlers are required for the group file.
81	n/a	__field_sep = [':']
82	n/a	if os.pathsep:
83	n/a	if os.pathsep != ':':
84	n/a	__field_sep.append(os.pathsep)
85	n/a
86	n/a	# helper routine to identify which separator character is in use
87	n/a	def __get_field_sep(record):
88	n/a	fs = None
89	n/a	for c in __field_sep:
90	n/a	# there should be 3 delimiter characters (for 4 fields)
91	n/a	if record.count(c) == 3:
92	n/a	fs = c
93	n/a	break
94	n/a	if fs:
95	n/a	return fs
96	n/a	else:
97	n/a	raise KeyError('>> group database fields not delimited <<')
98	n/a
99	n/a	# class to match the new record field name accessors.
100	n/a	# the resulting object is intended to behave like a read-only tuple,
101	n/a	# with each member also accessible by a field name.
102	n/a	class Group:
103	n/a	def __init__(self, name, passwd, gid, mem):
104	n/a	self.__dict__['gr_name'] = name
105	n/a	self.__dict__['gr_passwd'] = passwd
106	n/a	self.__dict__['gr_gid'] = gid
107	n/a	self.__dict__['gr_mem'] = mem
108	n/a	self.__dict__['_record'] = (self.gr_name, self.gr_passwd,
109	n/a	self.gr_gid, self.gr_mem)
110	n/a
111	n/a	def __len__(self):
112	n/a	return 4
113	n/a
114	n/a	def __getitem__(self, key):
115	n/a	return self._record[key]
116	n/a
117	n/a	def __setattr__(self, name, value):
118	n/a	raise AttributeError('attribute read-only: %s' % name)
119	n/a
120	n/a	def __repr__(self):
121	n/a	return str(self._record)
122	n/a
123	n/a	def __cmp__(self, other):
124	n/a	this = str(self._record)
125	n/a	if this == other:
126	n/a	return 0
127	n/a	elif this < other:
128	n/a	return -1
129	n/a	else:
130	n/a	return 1
131	n/a
132	n/a
133	n/a	# read the whole file, parsing each entry into tuple form
134	n/a	# with dictionaries to speed recall by GID or group name
135	n/a	def __read_group_file():
136	n/a	if group_file:
137	n/a	group = open(group_file, 'r')
138	n/a	else:
139	n/a	raise KeyError('>> no group database <<')
140	n/a	gidx = {}
141	n/a	namx = {}
142	n/a	sep = None
143	n/a	while 1:
144	n/a	entry = group.readline().strip()
145	n/a	if len(entry) > 3:
146	n/a	if sep is None:
147	n/a	sep = __get_field_sep(entry)
148	n/a	fields = entry.split(sep)
149	n/a	fields[2] = int(fields[2])
150	n/a	fields[3] = [f.strip() for f in fields[3].split(',')]
151	n/a	record = Group(*fields)
152	n/a	if fields[2] not in gidx:
153	n/a	gidx[fields[2]] = record
154	n/a	if fields[0] not in namx:
155	n/a	namx[fields[0]] = record
156	n/a	elif len(entry) > 0:
157	n/a	pass # skip empty or malformed records
158	n/a	else:
159	n/a	break
160	n/a	group.close()
161	n/a	if len(gidx) == 0:
162	n/a	raise KeyError
163	n/a	return (gidx, namx)
164	n/a
165	n/a	# return the group database entry by GID
166	n/a	def getgrgid(gid):
167	n/a	g, n = __read_group_file()
168	n/a	return g[gid]
169	n/a
170	n/a	# return the group database entry by group name
171	n/a	def getgrnam(name):
172	n/a	g, n = __read_group_file()
173	n/a	return n[name]
174	n/a
175	n/a	# return all the group database entries
176	n/a	def getgrall():
177	n/a	g, n = __read_group_file()
178	n/a	return g.values()
179	n/a
180	n/a	# test harness
181	n/a	if __name__ == '__main__':
182	n/a	getgrall()