python-doc-tw.github.io/library/filecmp.html at master · python-doc-tw/python-doc-tw.github.io

History

382 lines (339 loc) · 24.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>11.5. filecmp — File and Directory Comparisons — Python 3.7.0 說明文件</title>

title="在 Python 3.7.0 說明文件中搜尋"

href="../_static/opensearch.xml"/>

</head><body>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">索引</a></li>

<a href="../py-modindex.html" title="Python 模組索引"

>模組</a> |</li>

<a href="tempfile.html" title="11.6. tempfile — Generate temporary files and directories"

accesskey="N">下一頁</a> |</li>

<a href="stat.html" title="11.4. stat — Interpreting stat() results"

accesskey="P">上一頁</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

<li><a href="https://www.python.org/">Python</a> »</li>

<li>

zh_TW

3.7.0

<a href="../index.html">Documentation </a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python 標準函式庫 (Standard Library)</a> »</li>

<li class="nav-item nav-item-2"><a href="filesys.html" accesskey="U">11. 檔案與目錄存取</a> »</li>

</form>

</div>

</li>

</ul>

</div>

<h1>11.5. <a class="reference internal" href="#module-filecmp" title="filecmp: Compare files efficiently."><code class="xref py py-mod docutils literal notranslate">filecmp</code></a> — File and Directory Comparisons<a class="headerlink" href="#module-filecmp" title="本標題的永久連結">¶</a></h1>

Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.7/Lib/filecmp.py">Lib/filecmp.py</a>

The <a class="reference internal" href="#module-filecmp" title="filecmp: Compare files efficiently."><code class="xref py py-mod docutils literal notranslate">filecmp</code></a> module defines functions to compare files and directories,

with various optional time/correctness trade-offs. For comparing files,

see also the <a class="reference internal" href="difflib.html#module-difflib" title="difflib: Helpers for computing differences between objects."><code class="xref py py-mod docutils literal notranslate">difflib</code></a> module.

<code class="descclassname">filecmp.</code><code class="descname">cmp</code>(f1, f2, shallow=True)<a class="headerlink" href="#filecmp.cmp" title="本定義的永久連結">¶</a></dt>

<dd>Compare the files named f1 and f2, returning <code class="docutils literal notranslate">True</code> if they seem equal,

<code class="docutils literal notranslate">False</code> otherwise.

If shallow is true, files with identical <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate">os.stat()</code></a> signatures are

taken to be equal. Otherwise, the contents of the files are compared.

Note that no external programs are called from this function, giving it

portability and efficiency.

This function uses a cache for past comparisons and the results,

with cache entries invalidated if the <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate">os.stat()</code></a> information for the

file changes. The entire cache may be cleared using <a class="reference internal" href="#filecmp.clear_cache" title="filecmp.clear_cache"><code class="xref py py-func docutils literal notranslate">clear_cache()</code></a>.

</dd></dl>

<code class="descclassname">filecmp.</code><code class="descname">cmpfiles</code>(dir1, dir2, common, shallow=True)<a class="headerlink" href="#filecmp.cmpfiles" title="本定義的永久連結">¶</a></dt>

<dd>Compare the files in the two directories dir1 and dir2 whose names are

given by common.

Returns three lists of file names: match, mismatch,

errors. match contains the list of files that match, mismatch contains

the names of those that don’t, and errors lists the names of files which

could not be compared. Files are listed in errors if they don’t exist in

one of the directories, the user lacks permission to read them or if the

comparison could not be done for some other reason.

The shallow parameter has the same meaning and default value as for

<a class="reference internal" href="#filecmp.cmp" title="filecmp.cmp"><code class="xref py py-func docutils literal notranslate">filecmp.cmp()</code></a>.

For example, <code class="docutils literal notranslate">cmpfiles('a', 'b', ['c', 'd/e'])</code> will compare <code class="docutils literal notranslate">a/c</code> with

<code class="docutils literal notranslate">b/c</code> and <code class="docutils literal notranslate">a/d/e</code> with <code class="docutils literal notranslate">b/d/e</code>. <code class="docutils literal notranslate">'c'</code> and <code class="docutils literal notranslate">'d/e'</code> will each be in

one of the three returned lists.

</dd></dl>

<code class="descclassname">filecmp.</code><code class="descname">clear_cache</code>()<a class="headerlink" href="#filecmp.clear_cache" title="本定義的永久連結">¶</a></dt>

<dd>Clear the filecmp cache. This may be useful if a file is compared so quickly

after it is modified that it is within the mtime resolution of

the underlying filesystem.

3.4 版新加入.

</div>

</dd></dl>

<h2>11.5.1. The <a class="reference internal" href="#filecmp.dircmp" title="filecmp.dircmp"><code class="xref py py-class docutils literal notranslate">dircmp</code></a> class<a class="headerlink" href="#the-dircmp-class" title="本標題的永久連結">¶</a></h2>

class <code class="descclassname">filecmp.</code><code class="descname">dircmp</code>(a, b, ignore=None, hide=None)<a class="headerlink" href="#filecmp.dircmp" title="本定義的永久連結">¶</a></dt>

<dd>Construct a new directory comparison object, to compare the directories a

and b. ignore is a list of names to ignore, and defaults to

<a class="reference internal" href="#filecmp.DEFAULT_IGNORES" title="filecmp.DEFAULT_IGNORES"><code class="xref py py-attr docutils literal notranslate">filecmp.DEFAULT_IGNORES</code></a>. hide is a list of names to hide, and

defaults to <code class="docutils literal notranslate">[os.curdir, os.pardir]</code>.

The <a class="reference internal" href="#filecmp.dircmp" title="filecmp.dircmp"><code class="xref py py-class docutils literal notranslate">dircmp</code></a> class compares files by doing shallow comparisons

as described for <a class="reference internal" href="#filecmp.cmp" title="filecmp.cmp"><code class="xref py py-func docutils literal notranslate">filecmp.cmp()</code></a>.

<code class="descname">report</code>()<a class="headerlink" href="#filecmp.dircmp.report" title="本定義的永久連結">¶</a></dt>

<dd>Print (to <a class="reference internal" href="sys.html#sys.stdout" title="sys.stdout"><code class="xref py py-data docutils literal notranslate">sys.stdout</code></a>) a comparison between a and b.

</dd></dl>

<code class="descname">report_partial_closure</code>()<a class="headerlink" href="#filecmp.dircmp.report_partial_closure" title="本定義的永久連結">¶</a></dt>

<dd>Print a comparison between a and b and common immediate

subdirectories.

</dd></dl>

<code class="descname">report_full_closure</code>()<a class="headerlink" href="#filecmp.dircmp.report_full_closure" title="本定義的永久連結">¶</a></dt>

<dd>Print a comparison between a and b and common subdirectories

(recursively).

</dd></dl>

The <a class="reference internal" href="#filecmp.dircmp" title="filecmp.dircmp"><code class="xref py py-class docutils literal notranslate">dircmp</code></a> class offers a number of interesting attributes that may be

used to get various bits of information about the directory trees being

compared.

Note that via <a class="reference internal" href="../reference/datamodel.html#object.__getattr__" title="object.__getattr__"><code class="xref py py-meth docutils literal notranslate">__getattr__()</code></a> hooks, all attributes are computed lazily,

so there is no speed penalty if only those attributes which are lightweight

to compute are used.

<dd>The directory a.

</dd></dl>

<code class="descname">right</code><a class="headerlink" href="#filecmp.dircmp.right" title="本定義的永久連結">¶</a></dt>

<dd>The directory b.

</dd></dl>

<dd>Files and subdirectories in a, filtered by hide and ignore.

</dd></dl>

<code class="descname">right_list</code><a class="headerlink" href="#filecmp.dircmp.right_list" title="本定義的永久連結">¶</a></dt>

<dd>Files and subdirectories in b, filtered by hide and ignore.

</dd></dl>

<code class="descname">common</code><a class="headerlink" href="#filecmp.dircmp.common" title="本定義的永久連結">¶</a></dt>

<dd>Files and subdirectories in both a and b.

</dd></dl>

<dd>Files and subdirectories only in a.

</dd></dl>

<code class="descname">right_only</code><a class="headerlink" href="#filecmp.dircmp.right_only" title="本定義的永久連結">¶</a></dt>

<dd>Files and subdirectories only in b.

</dd></dl>

<code class="descname">common_dirs</code><a class="headerlink" href="#filecmp.dircmp.common_dirs" title="本定義的永久連結">¶</a></dt>

<dd>Subdirectories in both a and b.

</dd></dl>

<code class="descname">common_files</code><a class="headerlink" href="#filecmp.dircmp.common_files" title="本定義的永久連結">¶</a></dt>

<dd>Files in both a and b.

</dd></dl>

<code class="descname">common_funny</code><a class="headerlink" href="#filecmp.dircmp.common_funny" title="本定義的永久連結">¶</a></dt>

<dd>Names in both a and b, such that the type differs between the

directories, or names for which <a class="reference internal" href="os.html#os.stat" title="os.stat"><code class="xref py py-func docutils literal notranslate">os.stat()</code></a> reports an error.

</dd></dl>

<code class="descname">same_files</code><a class="headerlink" href="#filecmp.dircmp.same_files" title="本定義的永久連結">¶</a></dt>

<dd>Files which are identical in both a and b, using the class’s

file comparison operator.

</dd></dl>

<code class="descname">diff_files</code><a class="headerlink" href="#filecmp.dircmp.diff_files" title="本定義的永久連結">¶</a></dt>

<dd>Files which are in both a and b, whose contents differ according

to the class’s file comparison operator.

</dd></dl>

<code class="descname">funny_files</code><a class="headerlink" href="#filecmp.dircmp.funny_files" title="本定義的永久連結">¶</a></dt>

<dd>Files which are in both a and b, but could not be compared.

</dd></dl>

<code class="descname">subdirs</code><a class="headerlink" href="#filecmp.dircmp.subdirs" title="本定義的永久連結">¶</a></dt>

<dd>A dictionary mapping names in <a class="reference internal" href="#filecmp.dircmp.common_dirs" title="filecmp.dircmp.common_dirs"><code class="xref py py-attr docutils literal notranslate">common_dirs</code></a> to <a class="reference internal" href="#filecmp.dircmp" title="filecmp.dircmp"><code class="xref py py-class docutils literal notranslate">dircmp</code></a>

objects.

</dd></dl>

<code class="descclassname">filecmp.</code><code class="descname">DEFAULT_IGNORES</code><a class="headerlink" href="#filecmp.DEFAULT_IGNORES" title="本定義的永久連結">¶</a></dt>

3.4 版新加入.

</div>

List of directories ignored by <a class="reference internal" href="#filecmp.dircmp" title="filecmp.dircmp"><code class="xref py py-class docutils literal notranslate">dircmp</code></a> by default.

</dd></dl>

Here is a simplified example of using the <code class="docutils literal notranslate">subdirs</code> attribute to search

recursively through two directories to show common different files:

<div class="highlight-python3 notranslate"><div class="highlight"><pre>>>> from filecmp import dircmp

>>> def print_diff_files(dcmp):

... for name in dcmp.diff_files:

... print("diff_file %s found in %s and %s" % (name, dcmp.left,

... dcmp.right))

... for sub_dcmp in dcmp.subdirs.values():

... print_diff_files(sub_dcmp)

...

>>> dcmp = dircmp('dir1', 'dir2')

>>> print_diff_files(dcmp)

</pre></div>

</div>

<ul>

<li><a class="reference internal" href="#">11.5. <code class="docutils literal notranslate">filecmp</code> — File and Directory Comparisons</a><ul>

<li><a class="reference internal" href="#the-dircmp-class">11.5.1. The <code class="docutils literal notranslate">dircmp</code> class</a></li>

</ul>

</li>

</ul>

<a href="stat.html"

title="上一章">11.4. <code class="docutils literal notranslate">stat</code> — Interpreting <code class="docutils literal notranslate">stat()</code> results</a>

<a href="tempfile.html"

title="下一章">11.6. <code class="docutils literal notranslate">tempfile</code> — Generate temporary files and directories</a>

<li><a href="../bugs.html">Report a Bug</a></li>

<li>

<a href="https://github.com/python/cpython/blob/3.7/Doc/library/filecmp.rst"

rel="nofollow">Show Source

</a>

</li>

</ul>

</div>

</div>

<ul>

<a href="../genindex.html" title="General Index"

>索引</a></li>

<a href="../py-modindex.html" title="Python 模組索引"

>模組</a> |</li>

<a href="tempfile.html" title="11.6. tempfile — Generate temporary files and directories"

>下一頁</a> |</li>

<a href="stat.html" title="11.4. stat — Interpreting stat() results"

>上一頁</a> |</li>

<li><img src="../_static/py.png" alt=""

style="vertical-align: middle; margin-top: -1px"/></li>

<li><a href="https://www.python.org/">Python</a> »</li>

<li>

zh_TW

3.7.0

<a href="../index.html">Documentation </a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python 標準函式庫 (Standard Library)</a> »</li>

<li class="nav-item nav-item-2"><a href="filesys.html" >11. 檔案與目錄存取</a> »</li>

</form>

</div>

</li>

</ul>

</div>

The Python Software Foundation is a non-profit corporation.

<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on 8月 22, 2018.

<a href="../bugs.html">Found a bug</a>?

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.7.

</div>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

filecmp.html

Latest commit

History

filecmp.html

File metadata and controls