Check if object is file-like in Python

by

For 3.1+, one of the following:

isinstance(something, io.TextIOBase)
isinstance(something, io.BufferedIOBase)
isinstance(something, io.RawIOBase)
isinstance(something, io.IOBase)

For 2.x, “file-like object” is too vague a thing to check for, but the documentation for whatever function(s) you’re dealing with will hopefully tell you what they actually need; if not, read the code.

As other answers point out, the first thing to ask is what exactly you’re checking for. Usually, EAFP is sufficient, and more idiomatic.

The glossary says “file-like object” is a synonym for “file object”, which ultimately means it’s an instance of one of the three abstract base classes defined in the io module, which are themselves all subclasses of IOBase. So, the way to check is exactly as shown above.

(However, checking IOBase isn’t very useful. Can you imagine a case where you need to distinguish an actual file-like read(size) from some one-argument function named read that isn’t file-like, without also needing to distinguish between text files and raw binary files? So, really, you almost always want to check, e.g., “is a text file object”, not “is a file-like object”.)

For 2.x, while the io module has existed since 2.6+, built-in file objects are not instances of io classes, neither are any of the file-like objects in the stdlib, and neither are most third-party file-like objects you’re likely to encounter. There was no official definition of what “file-like object” means; it’s just “something like a builtin file object“, and different functions mean different things by “like”. Such functions should document what they mean; if they don’t, you have to look at the code.

However, the most common meanings are “has read(size)“, “has read()“, or “is an iterable of strings”, but some old libraries may expect readline instead of one of those, some libraries like to close() files you give them, some will expect that if fileno is present then other functionality is available, etc. And similarly for write(buf) (although there are a lot fewer options in that direction).

More Related Contents:

  1. How do I check whether a file exists without exceptions?
  2. Flask raises TemplateNotFound error even though template file exists
  3. Writing a list to a file with Python
  4. How to read specific lines from a file (by line number)?
  5. How do I check file size in Python?
  6. Python convert csv to xlsx
  7. logger configuration to log to file and print to stdout
  8. What is the perfect counterpart in Python for “while not EOF”
  9. Using MultipartPostHandler to POST form-data with Python
  10. Pythonic way to check if a file exists? [duplicate]
  11. file.tell() inconsistency
  12. .write not working in Python
  13. Python list directory, subdirectory, and files
  14. Seeking from end of file throwing unsupported exception
  15. What does ‘wb’ mean in this code, using Python?
  16. How to save a list to a file and read it as a list type?
  17. How do you read a file into a list in Python? [duplicate]
  18. How to delete the first line of a text file?
  19. Get Line Number of certain phrase in file Python
  20. Open files in ‘rt’ and ‘wt’ modes
  21. parsing a fasta file using a generator ( python )
  22. Re-open files in Python?
  23. Memory error due to the huge input file size
  24. How do I move a file in Python?
  25. What is the difference between rb and r+b modes in file objects [duplicate]
  26. Download and decompress gzipped file in memory?
  27. Why is `with open()` better for opening files in Python?
  28. HTML to IMAGE using Python
  29. UTF-8 HTML and CSS files with BOM (and how to remove the BOM with Python)
  30. Change the file extension for files in a folder?

Leave a Comment