|
147.1.3
by Robert Collins
test and deliver basic pending-merges into bzr so that merging is recorded |
1 |
====================== |
2 |
History of API Changes |
|
3 |
====================== |
|
4 |
||
5 |
||
6 |
ddaa@ddaa.net--2004/pyarch--ddaa--0.5--patch-175 |
|
7 |
================================================
|
|
8 |
||
9 |
Finished the deprecation of the getter methods in Patchlog. |
|
10 |
||
11 |
Deprecated usage | Recommended replacement |
|
12 |
------------------------------+------------------------
|
|
13 |
patchlog.get_description() | patchlog.description |
|
14 |
patchlog.get_date() | patchlog.date |
|
15 |
patchlog.get_creator() | patchlog.creator |
|
16 |
patchlog.get_continuation() | patchlog.continuation_of |
|
17 |
patchlog.continuation | patchlog.continuation_of |
|
18 |
patchlog.get_new_patches() | patchlog.new_patches |
|
19 |
patchlog.get_merged_patches() | patchlog.merged_patches |
|
20 |
patchlog.get_new_files() | patchlog.new_files |
|
21 |
patchlog.get_modified_files() | patchlog.modified_files |
|
22 |
patchlog.get_renamed_files() | patchlog.renamed_files |
|
23 |
patchlog.get_removed_files() | patchlog.removed_files |
|
24 |
|
|
25 |
||
26 |
Before ddaa@ddaa.net--2004/pyarch--ddaa--0.5--patch-175 |
|
27 |
=======================================================
|
|
28 |
||
29 |
Date: 2004-01-16 |
|
30 |
||
31 |
Deprecate numerous methods and functions in favour of simpler syntaxes. |
|
32 |
||
33 |
||
34 |
Deprecated arch.arch module |
|
35 |
---------------------------
|
|
36 |
||
37 |
The arch.arch module has been deprecated, and some trouble has been |
|
38 |
taken so that the high-level interface appears documented as part of |
|
39 |
the arch package. |
|
40 |
||
41 |
Deprecated usage | Recommended replacement |
|
42 |
------------------------------+------------------------
|
|
43 |
from arch import arch | import arch |
|
44 |
||
45 |
||
46 |
Deprecated getters in favour of properties |
|
47 |
------------------------------------------
|
|
48 |
||
49 |
Read-only values which are normally immutable, and which are thus |
|
50 |
susceptible to memoization, are represented in PyArch as properties. |
|
51 |
||
52 |
Many of those properties were originally defined using public getter |
|
53 |
methods. Now, they are defined using protected methods and the public |
|
54 |
methods are deprecated. |
|
55 |
||
56 |
Deprecated usage | Recommended replacement |
|
57 |
------------------------------+------------------------
|
|
58 |
category.get_archive() | category.archive |
|
59 |
branch.get_archive() | branch.archive |
|
60 |
version.get_archive() | version.archive |
|
61 |
revision.get_archive() | revision.archive |
|
62 |
| |
|
63 |
category.get_nonarch() | category.nonarch |
|
64 |
branch.get_nonarch() | branch.nonarch |
|
65 |
version.get_nonarch() | version.nonarch |
|
66 |
revision.get_nonarch() | revision.nonarch |
|
67 |
| |
|
68 |
archive.get_fullname() | archive.fullname |
|
69 |
category.get_fullname() | category.fullname |
|
70 |
branch.get_fullname() | branch.fullname |
|
71 |
version.get_fullname() | version.fullname |
|
72 |
revision.get_fullname() | revision.fullname |
|
73 |
| |
|
74 |
version.get_branch() | version.branch |
|
75 |
revision.get_branch() | revision.branch |
|
76 |
| |
|
77 |
revision.get_version() | revision.version |
|
78 |
revision.get_patchlevel() | revision.patchlevel |
|
79 |
| |
|
80 |
archive.get_name() | archive.name |
|
81 |
archive.get_location() | archive.location |
|
82 |
archive.get_is_mirror() | archive.is_mirror |
|
83 |
archive.get_official_name() | archive.official_name |
|
84 |
archive.get_is_signed() | archive.is_signed |
|
85 |
archive.get_has_listings() | archive.has_listings |
|
86 |
| |
|
87 |
revision.get_patchlog() | revision.patchlog |
|
88 |
revision.get_ancestor() | revision.ancestor |
|
89 |
revision.get_previous() | revision.previous |
|
90 |
| |
|
91 |
patchlog.get_revision() | patchlog.revision |
|
92 |
patchlog.get_summary() | patchlog.summary |
|
93 |
|
|
94 |
||
95 |
Deprecated instance sequences in favour of iterators |
|
96 |
----------------------------------------------------
|
|
97 |
||
98 |
Methods which return sequences have been deprecated in favour of |
|
99 |
similar methods returning iterators. |
|
100 |
||
101 |
Also a few properties returning non-memoisable sequences (categories, |
|
102 |
branches, versions, revisions) have been deprecated in the same way. |
|
103 |
||
104 |
Deprecated usage | Recommended replacement |
|
105 |
---------------------------------+------------------------
|
|
106 |
archive.get_categories() | list(archive.iter_categories()) |
|
107 |
archive.categories | list(archive.iter_categories()) |
|
108 |
archive.get_library_categories() | list(archive.iter_library_categories()) |
|
109 |
archive.library_categories | list(archive.iter_library_categories()) |
|
110 |
| |
|
111 |
category.get_branches() | list(category.iter_branches()) |
|
112 |
category.branches | list(category.iter_branches()) |
|
113 |
category.get_library_branches() | list(category.iter_library_branches()) |
|
114 |
category.library_branches | list(category.iter_library_branches()) |
|
115 |
| |
|
116 |
branch.get_versions() | list(category.iter_versions()) |
|
117 |
branch.versions | list(category.iter_versions()) |
|
118 |
| |
|
119 |
branch.get_library_versions() | list(branch.iter_library_versions()) |
|
120 |
branch.library_versions | list(branch.iter_library_versions()) |
|
121 |
| |
|
122 |
version.get_revisions() | list(version.iter_revisions()) |
|
123 |
version.revisions | list(version.iter_revisions()) |
|
124 |
| |
|
125 |
version.get_library_revisions() | list(version.iter_library_revisions()) |
|
126 |
version.library_revisions | list(version.iter_library_revisions()) |
|
127 |
|
|
128 |
||
129 |
Deprecated package conversion |
|
130 |
-----------------------------
|
|
131 |
||
132 |
The as_version() and as_revision() methods where introduced to make it |
|
133 |
possible to indifferently process branches, versions, or revisions. It |
|
134 |
turned out to be a bad idea. In useful cases, those methods just were |
|
135 |
named in a way that did not say what they do, and in the other cases |
|
136 |
they were just foolish consistency. |
|
137 |
||
138 |
Deprecated usage | Recommended replacement |
|
139 |
---------------------------------+------------------------
|
|
140 |
branch.as_version() | branch.latest_version() |
|
141 |
version.as_version() | version |
|
142 |
| |
|
143 |
branch.as_revision() | branch.latest_revision() |
|
144 |
version.as_revision() | version.latest_revision() |
|
145 |
revision.as_revision() | revision |
|
146 |
|
|
147 |
||
148 |
Deprecated function usage |
|
149 |
-------------------------
|
|
150 |
||
151 |
Explicit is better than implicit, and in addition these methods are often used |
|
152 |
as part of input validation, so it's better to be explicit when the current |
|
153 |
directory is used.
|
|
154 |
||
155 |
Deprecated usage | Recommended replacement
|
|
156 |
---------------------------------+------------------------
|
|
157 |
arch.in_source_tree() | arch.in_source_tree('.') |
|
158 |
arch.tree_root() | arch.tree_root('.') |
|
159 |
|
|
160 |
||
161 |
Removed functions |
|
162 |
-----------------
|
|
163 |
||
164 |
Several functions are now superseded by more generic functions, |
|
165 |
iterator forms, or methods. |
|
166 |
||
167 |
Deprecated usage | Recommended replacement |
|
168 |
---------------------------------+------------------------
|
|
169 |
arch.changeset(orig, mod, dest) | arch.delta(ArchSourceTree(orig), |
|
170 |
| ArchSourceTree(mod), dest) |
|
171 |
arch.archives() | list(arch.iter_archives()) |
|
172 |
arch.library_archives() | list(arch.iter_library_archives()) |
|
173 |
arch.make_continuation(rev, vsn) | rev.make_continuation(vsn) |
|
174 |
arch.get(revision, dir, link) | revision.get(dir, link) |
|
175 |
arch.get_patch(revision, dir) | revision.get_patch(dir) |
|
176 |
|
|
177 |
||
178 |
Removed functions without replacement |
|
179 |
-------------------------------------
|
|
180 |
||
181 |
These functions are trivial or do not belong in generic library bindings. |
|
182 |
I wrote them early in the development of pyrach for experimentation purposes. |
|
183 |
||
184 |
arch.filter_archive_logs(limit, pred) |
|
185 |
arch.filter_revisions(limit, pred) |
|
186 |
arch.grep_summary(limit, rx) |
|
187 |
arch.grep_summary_interactive(limit) |
|
188 |
arch.suspected_move(limit) |
|
189 |
arch.revisions_merging(limit, rev) |
|
190 |
arch.temphack(revision) |
|
191 |
arch.revision_which_created(file, revision) |
|
192 |
arch.last_revision(tree) |
|
193 |
arch.map_name_id(tree) |