Skip to content

Instantly share code, notes, and snippets.

@jtriley
Created July 26, 2011 21:58
Show Gist options
  • Save jtriley/1108174 to your computer and use it in GitHub Desktop.
Save jtriley/1108174 to your computer and use it in GitHub Desktop.
Get current terminal size on Linux, Mac, and Windows
#!/usr/bin/env python
import os
import shlex
import struct
import platform
import subprocess
def get_terminal_size():
""" getTerminalSize()
- get width and height of console
- works on linux,os x,windows,cygwin(windows)
originally retrieved from:
http://stackoverflow.com/questions/566746/how-to-get-console-window-width-in-python
"""
current_os = platform.system()
tuple_xy = None
if current_os == 'Windows':
tuple_xy = _get_terminal_size_windows()
if tuple_xy is None:
tuple_xy = _get_terminal_size_tput()
# needed for window's python in cygwin's xterm!
if current_os in ['Linux', 'Darwin'] or current_os.startswith('CYGWIN'):
tuple_xy = _get_terminal_size_linux()
if tuple_xy is None:
print "default"
tuple_xy = (80, 25) # default value
return tuple_xy
def _get_terminal_size_windows():
try:
from ctypes import windll, create_string_buffer
# stdin handle is -10
# stdout handle is -11
# stderr handle is -12
h = windll.kernel32.GetStdHandle(-12)
csbi = create_string_buffer(22)
res = windll.kernel32.GetConsoleScreenBufferInfo(h, csbi)
if res:
(bufx, bufy, curx, cury, wattr,
left, top, right, bottom,
maxx, maxy) = struct.unpack("hhhhHhhhhhh", csbi.raw)
sizex = right - left + 1
sizey = bottom - top + 1
return sizex, sizey
except:
pass
def _get_terminal_size_tput():
# get terminal width
# src: http://stackoverflow.com/questions/263890/how-do-i-find-the-width-height-of-a-terminal-window
try:
cols = int(subprocess.check_call(shlex.split('tput cols')))
rows = int(subprocess.check_call(shlex.split('tput lines')))
return (cols, rows)
except:
pass
def _get_terminal_size_linux():
def ioctl_GWINSZ(fd):
try:
import fcntl
import termios
cr = struct.unpack('hh',
fcntl.ioctl(fd, termios.TIOCGWINSZ, '1234'))
return cr
except:
pass
cr = ioctl_GWINSZ(0) or ioctl_GWINSZ(1) or ioctl_GWINSZ(2)
if not cr:
try:
fd = os.open(os.ctermid(), os.O_RDONLY)
cr = ioctl_GWINSZ(fd)
os.close(fd)
except:
pass
if not cr:
try:
cr = (os.environ['LINES'], os.environ['COLUMNS'])
except:
return None
return int(cr[1]), int(cr[0])
if __name__ == "__main__":
sizex, sizey = get_terminal_size()
print 'width =', sizex, 'height =', sizey
@Chronial
Copy link

Chronial commented Feb 3, 2018

Note that there is python standard lib function for this now: os.get_terminal_size()

@arvestad
Copy link

arvestad commented Oct 5, 2018

Thanks @Chronial for pointing this out! I note however that the docs for os.get_terminal_size() says that shutil.get_terminal_size() is the high-level call that should normally be used.

@kodekage
Copy link

kodekage commented Jun 30, 2020

What python version is supported?

I'm running the script with python3 and I'm getting syntax errors

py-error

@hyperclick
Copy link

@andrebtw
Copy link

If you want to get the terminal size on all OS now you just gotta do :

import os
width, height = os.get_terminal_size()

have a nice day 😃

@ola-sk
Copy link

ola-sk commented Jul 21, 2022

@andrebtw:

If you want to get the terminal size on all OS now you just gotta do :

import os
width, height = os.get_terminal_size()

have a nice day 😃

Nope. Doesn't work on Windows 10 for me. The shutil.get_terminal_size() does work tough, just like @arvestad said

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment