mirror of
				https://github.com/python/cpython.git
				synced 2025-10-31 05:31:20 +00:00 
			
		
		
		
	Issue #7545: improve documentation of the buffering argument in io.open().
				
					
				
			This commit is contained in:
		
							parent
							
								
									d86e9d7616
								
							
						
					
					
						commit
						e812d29b52
					
				
					 3 changed files with 43 additions and 8 deletions
				
			
		
							
								
								
									
										15
									
								
								Lib/_pyio.py
									
										
									
									
									
								
							
							
						
						
									
										15
									
								
								Lib/_pyio.py
									
										
									
									
									
								
							|  | @ -92,6 +92,21 @@ def open(file, mode="r", buffering=None, | |||
|     allowed in binary mode), 1 to set line buffering, and an integer > 1 | ||||
|     for full buffering. | ||||
| 
 | ||||
|     buffering is an optional integer used to set the buffering policy. | ||||
|     Pass 0 to switch buffering off (only allowed in binary mode), 1 to select | ||||
|     line buffering (only usable in text mode), and an integer > 1 to indicate | ||||
|     the size of a fixed-size chunk buffer.  When no buffering argument is | ||||
|     given, the default buffering policy works as follows: | ||||
| 
 | ||||
|     * Binary files are buffered in fixed-size chunks; the size of the buffer | ||||
|       is chosen using a heuristic trying to determine the underlying device's | ||||
|       "block size" and falling back on `io.DEFAULT_BUFFER_SIZE`. | ||||
|       On many systems, the buffer will typically be 4096 or 8192 bytes long. | ||||
| 
 | ||||
|     * "Interactive" text files (files for which isatty() returns True) | ||||
|       use line buffering.  Other text files use the policy described above | ||||
|       for binary files. | ||||
| 
 | ||||
|     encoding is the name of the encoding used to decode or encode the | ||||
|     file. This should only be used in text mode. The default encoding is | ||||
|     platform dependent, but any encoding supported by Python can be | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Antoine Pitrou
						Antoine Pitrou